Skip to content

Commit c26343c

Browse files
docs: 📝 Update main README formatting
1 parent 675fd6c commit c26343c

1 file changed

Lines changed: 15 additions & 20 deletions

File tree

README.md

Lines changed: 15 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22

33
[![Downloads](https://static.pepy.tech/personalized-badge/pyedgeconnect?period=total&units=none&left_color=grey&right_color=orange&left_text=PyPI%20Downloads)](https://pepy.tech/project/pyedgeconnect)
44

5-
65
This package is a python wrapper for leveraging the API for Aruba
76
Orchestrator and Edge Connect SDWAN systems.
87

@@ -12,13 +11,8 @@ Edge Connect web interfaces under "Support > Rest API"
1211
Many, but not all API functions have been implemented yet. Development
1312
is underway to continue to add further functions.
1413

15-
As of 0.14.0+ 64% of non-deprecated Swagger functions are covered.
16-
17-
18-
1914
## Install
2015

21-
2216
### Python Version
2317

2418
> **Note:** Requires Python 3.9.0+ (due to PEP585 type-hinting e.g. ``def my_func(var1 = list[str]``)
@@ -62,7 +56,7 @@ Now you can install the package and run your python code
6256
### Install from PyPI
6357

6458
```bash
65-
$ pip install pyedgeconnect
59+
pip install pyedgeconnect
6660
```
6761

6862
### Install from GitHub
@@ -73,13 +67,13 @@ interactive shell and run:
7367
> **Note:** These commands assume you're within a Python 3.9 venv, or Python 3.9 is the exclusive Python version installed in regard to referencing the use of ``pip``. If that is not the case, you can specifically append ``python3.9 -m`` ahead of the ``pip install ...``
7468
7569
```bash
76-
$ pip install git+https://github.com/SPOpenSource/edgeconnect-python
70+
pip install git+https://github.com/SPOpenSource/edgeconnect-python
7771
```
7872

7973
To install a specific branch use the @branch syntax
8074

8175
```bash
82-
$ pip install git+https://github.com/SPOpenSource/edgeconnect-python@<branch_name>
76+
pip install git+https://github.com/SPOpenSource/edgeconnect-python@<branch_name>
8377
```
8478

8579
### Install dev options
@@ -94,7 +88,7 @@ following syntax:
9488
```bash
9589
$ pip install pyedgeconnect[dev]
9690
or
97-
$ pip install -e git+https://github.com/SPOpenSource/edgeconnect-python#egg=pyedgeconnect[dev]
91+
$ pip install -e git+https://github.com/SPOpenSource/edgeconnect-python#egg=pyedgeconnect[dev]
9892
```
9993

10094
## Docs
@@ -107,11 +101,11 @@ To build the documentation locally, clone the repository, install with ``[dev]``
107101
to include sphinx and related packages, then in the docs directory run ``make html``
108102

109103
```bash
110-
$ git clone https://github.com/SPOpenSource/edgeconnect-python.git
111-
$ cd edgeconnect-python
112-
$ pip install .[dev]
113-
$ cd docs
114-
$ make html
104+
git clone https://github.com/SPOpenSource/edgeconnect-python.git
105+
cd edgeconnect-python
106+
pip install .[dev]
107+
cd docs
108+
make html
115109
```
116110

117111
## Usage
@@ -216,15 +210,17 @@ In the [Examples](/examples) directory you can find scripts leveraging
216210
the Orchestrator class demonstrating some uses
217211

218212
* [create_user.py](/examples/create_user.py)
219-
* creates a new read-only user on Orchestrator and returns the
213+
* creates a new read-only user on Orchestrator and returns the
220214
configured details
221215
* [print_appliance_info.py](/examples/print_appliance_info.py)
222-
* retrieves all appliances, retrieves detailed attributes of the
216+
* retrieves all appliances, retrieves detailed attributes of the
223217
appliances, and prints details in a table format
224218
* [run_packet_capture.py](/examples/run_packet_capture.py)
225-
* runs a tcpdump packet capture on a specified appliance, once
219+
* runs a tcpdump packet capture on a specified appliance, once
226220
completed, uploads to Orchestrator for user retrieval
227-
221+
* [preconfig.py](/examples/generate_preconfig/preconfig.py)
222+
* uses a CSV file as source data to generate Edge Connect YAML
223+
preconfig from a Jinja template
228224

229225
## This is an alpha product
230226

@@ -258,7 +254,6 @@ See contribution details at [Contributing](CONTRIBUTING.md)
258254

259255
Release notes are located in ``docs/source/release-notes`` directory [here](docs/source/release-notes)
260256

261-
262257
## Authors
263258

264259
Authored by Zach Camara, email at <zachary.camara@hpe.com>

0 commit comments

Comments
 (0)