Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
Tes3awy committed Aug 17, 2021
1 parent 557c0ad commit b10a017
Showing 1 changed file with 17 additions and 18 deletions.
35 changes: 17 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,15 @@
![Cisco DevNet](https://img.shields.io/badge/Cisco-DevNet-blue)
[![Tested on Python 3.6+](https://img.shields.io/badge/Python%203.6+-blue.svg?logo=python&logoColor=white)](https://www.python.org/downloads)
![Language](https://img.shields.io/github/languages/top/Tes3awy/Netmiko-Examples)
![Repo Size](https://img.shields.io/github/repo-size/Tes3awy/Netmiko-Examples)
[![Issues Open](https://img.shields.io/github/issues/Tes3awy/Netmiko-Examples)](https://github.com/Tes3awy/Netmiko-Examples/issues)
![Releases Download](https://img.shields.io/github/downloads/Tes3awy/Netmiko-Examples/total)
[![Commit Activity](https://img.shields.io/github/commit-activity/m/Tes3awy/Netmiko-Examples)](https://github.com/Tes3awy/Netmiko-Examples/commits/main)
![Last Commit](https://img.shields.io/github/last-commit/Tes3awy/Netmiko-Examples)
[![Release Date](https://img.shields.io/github/release-date/Tes3awy/Netmiko-Examples)](https://github.com/Tes3awy/Netmiko-Examples/releases)
[![License](https://img.shields.io/github/license/Tes3awy/Netmiko-Examples)](https://github.com/Tes3awy/Netmiko-Examples/blob/main/LICENSE)
[![Black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
[![Imports: isort](https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336)](https://pycqa.github.io/isort/)
[![Pre-Commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit)
![Cisco DevNet](https://img.shields.io/badge/Cisco-DevNet-blue?style=flat-square)
[![Python 3.6+](https://img.shields.io/badge/Python%203.6+-blue.svg?logo=python&logoColor=yellow&color=black&style=flat-square)](https://www.python.org/downloads)
![Language](https://img.shields.io/github/languages/top/Tes3awy/Netmiko-Examples?label=Python&style=flat-square)
![Repo Size](https://img.shields.io/github/repo-size/Tes3awy/Netmiko-Examples?label=Repo%20size&style=flat-square)
[![Issues Open](https://img.shields.io/github/issues/Tes3awy/Netmiko-Examples?label=Issues&style=flat-square)](https://github.com/Tes3awy/Netmiko-Examples/issues)
![Releases Download](https://img.shields.io/github/downloads/Tes3awy/Netmiko-Examples/total?label=Downloads&style=flat-square)
[![Commit Activity](https://img.shields.io/github/commit-activity/m/Tes3awy/Netmiko-Examples?label=Commit%20activity&style=flat-square)](https://github.com/Tes3awy/Netmiko-Examples/commits/main)
![Last Commit](https://img.shields.io/github/last-commit/Tes3awy/Netmiko-Examples?label=Last%20commit&style=flat-square)
[![License](https://img.shields.io/github/license/Tes3awy/Netmiko-Examples?label=License&style=flat-square&color=purple)](https://github.com/Tes3awy/Netmiko-Examples/blob/main/LICENSE)
[![Black](https://img.shields.io/badge/code%20style-black-000000.svg?style=flat-square)](https://github.com/psf/black)
[![Imports: isort](https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat-square&labelColor=ef8336)](https://pycqa.github.io/isort/)
[![Pre-Commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white&style=flat-square)](https://github.com/pre-commit/pre-commit)

# Netmiko & Requests Examples for Cisco DevNet

Expand All @@ -20,7 +19,7 @@

## How to use?

1. `Clone` this repo or `Download ZIP` by clicking on <img src="assets/code-button.png" alt="Code Button" title="Button" width="100"/> up above.
1. `Clone` this repo or `Download ZIP` by clicking on <img src="assets/code-button.png" alt="Code Button" title="Button" width="80"/> up above.
_(Alternativley, you can click on Releases on the right hand side and download the latest release)_

2. Once downloaded, extract the ZIP file and `cd` into `netmiko` folder or `requests` folder.
Expand All @@ -33,15 +32,15 @@
path_to\folder> pip install -r requirements.txt --user ↵
```

Alternativley, if the libraries installed already but not the same version as in `requirements.txt`, then add `--upgrade` flag to the `pip install` command:
> If the libraries already installed but not the same version as in `requirements.txt`, then add `--upgrade` flag to the `pip install` command:
```powershell
path_to\folder> pip install -r requirements.txt --user --upgrade ↵
```

5. Explore each `example*.py` file. _**(where **\*** is the number of the example)**_

6. Run any Python example by typing the following command in PowerShell terminal:
6. Run any Python example by typing the following command in PowerShell terminal _(Either integrated terminal in VSCode or standablone Windows PowerShell/CMD)_:

```powershell
path_to\folder> python example*.py ↵
Expand All @@ -55,7 +54,7 @@ Examples in `netmiko` and `requests` folder uses some Python libraries. These li

1. Netmiko **v3.4.0** (Multi-vendor library to simplify Paramiko SSH connections to network devices) [Documentation Link](https://github.com/ktbyers/netmiko/blob/develop/README.md).
2. NTC Templates **v2.2.0** (TextFSM templates for parsing show commands of network devices) [Documentation Link](https://github.com/networktocode/ntc-templates).
3. XlsxWriter **v2.0.0** (XlsxWriter is a Python module for creating Excel XLSX files) [Documentation Link](https://xlsxwriter.readthedocs.io/).
4. Pandas **v1.3.1** (Data Analysis Library) [Documentation Link](https://pandas.pydata.org/docs/).
3. XlsxWriter **v3.0.1** (XlsxWriter is a Python module for creating Excel XLSX files) [Documentation Link](https://xlsxwriter.readthedocs.io/).
4. Pandas **v1.3.2** (Data Analysis Library) [Documentation Link](https://pandas.pydata.org/docs/).
5. Openpyxl **v3.0.7** (A Python library to read/write Excel 2010 xlsx/xlsm files) [Documentation Link](https://openpyxl.readthedocs.io/en/stable/).
6. Requests **v2.26.0** (HTTP Requests) [Documentation Link](https://docs.python-requests.org/en/master/).

0 comments on commit b10a017

Please sign in to comment.