Skip to content

Commit 90a96f5

Browse files
zachcamara-hpezachcamara-hpe
committed
docs: 📝 Update docs and setup.py for 3.7+ compatability
1 parent cfc799d commit 90a96f5

3 files changed

Lines changed: 68 additions & 71 deletions

File tree

‎README.md‎

Lines changed: 29 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -15,65 +15,65 @@ is underway to continue to add further functions.
1515

1616
### Python Version
1717

18-
> **Note:** Requires Python 3.9.0+ (due to PEP585 type-hinting e.g. ``def my_func(var1 = list[str]``)
18+
> **Note:** Requires Python 3.7+
1919
20-
Once Python 3.9 is installed on the system, it's recommended to use a
20+
Once Python 3.7+ is installed on the system, it's recommended to use a
2121
virtual environment to install the package to.
2222

2323
In the directory you'd like to write your project/script, setup a python
24-
virtual environment specifically with python3.9 and activate it. This
24+
virtual environment with the desired python version and activate it. This
2525
is important if you have other versions of python installed on your
2626
system.
2727

2828
```bash
2929

3030
:~$ python3.9 -m venv my_new_project
3131
:~$ source my_new_project/bin/activate
32-
(my_new_project) :~$ python3 --version
33-
Python 3.9.0+
32+
(my_new_project) :~$ python --version
33+
Python 3.9.13
3434
```
3535

36-
Now you can install the package and run your python code
36+
Now you are ready to install the package and run your python code.
3737

38-
```bash
39-
40-
(my_new_project) :~$ pip install git+https://github.com/SPOpenSource/edgeconnect-python
41-
...
42-
(my_new_project) :~$ pip list
43-
Package Version
44-
--------------------- --------------------------------
45-
certifi 2020.12.5
46-
chardet 4.0.0
47-
idna 2.10
48-
pip 20.0.2
49-
pkg-resources 0.0.0
50-
requests 2.25.1
51-
setuptools 44.0.0
52-
pyedgeconnect 0.13.0a2.dev1+g45fd843.d20210428
53-
urllib3 1.26.4
54-
```
38+
> **Note:** Going forward, these commands assume you're within a Python 3.7+ venv, or Python 3.7+ 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.x -m`` ahead of the ``pip install ...``
5539
5640
### Install from PyPI
5741

5842
```bash
59-
pip install pyedgeconnect
43+
$ pip install pyedgeconnect
44+
...
45+
$ pip list
46+
Package Version
47+
----------------------------- --------------------------------
48+
... ...
49+
pyedgeconnect x.y.z
50+
... ...
6051
```
6152

6253
### Install from GitHub
6354

6455
To install the most recent version of pyedgeconnect, open an
6556
interactive shell and run:
6657

67-
> **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 ...``
68-
6958
```bash
70-
pip install git+https://github.com/SPOpenSource/edgeconnect-python
59+
$ pip install git+https://github.com/SPOpenSource/edgeconnect-python
60+
...
61+
$ pip list
62+
Package Version
63+
----------------------------- --------------------------------
64+
... ...
65+
pyedgeconnect x.y.z
66+
... ...
7167
```
7268

7369
To install a specific branch use the @branch syntax
7470

7571
```bash
76-
pip install git+https://github.com/SPOpenSource/edgeconnect-python@<branch_name>
72+
$ pip install git+https://github.com/SPOpenSource/edgeconnect-python@<branch_name>
73+
...
74+
# Install the Development branch
75+
$ pip install git+https://github.com/SPOpenSource/edgeconnect-python@Development
76+
...
7777
```
7878

7979
### Install dev options
@@ -88,7 +88,7 @@ following syntax:
8888
```bash
8989
$ pip install pyedgeconnect[dev]
9090
or
91-
$ pip install -e git+https://github.com/SPOpenSource/edgeconnect-python#egg=pyedgeconnect[dev]
91+
$ pip install git+https://github.com/SPOpenSource/edgeconnect-python#egg=pyedgeconnect[dev]
9292
```
9393

9494
## Docs

‎docs/source/install.rst‎

Lines changed: 37 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -7,14 +7,13 @@ Python Version
77

88
.. note::
99

10-
Requires Python 3.9.0+ (due to PEP585 type-hinting e.g.
11-
``def my_func(var1 = list[str]``)
10+
Requires Python 3.7+
1211

13-
Once Python 3.9 is installed on the system, it's recommended to use a
12+
Once Python 3.7+ is installed on the system, it's recommended to use a
1413
virtual environment to install the package to.
1514

1615
In the directory you'd like to write your project/script, setup a python
17-
virtual environment specifically with python3.9 and activate it. This
16+
virtual environment with the desired python version and activate it. This
1817
is important if you have other versions of python installed on your
1918
system.
2019

@@ -23,61 +22,57 @@ system.
2322
:~$ python3.9 -m venv my_new_project
2423
:~$ source my_new_project/bin/activate
2524
(my_new_project) :~$ python3 --version
26-
Python 3.9.0+
25+
Python 3.9.13
2726
28-
Now you can install the package and run your python code
27+
Now you are ready to install the package and run your python code.
2928

30-
.. code:: bash
29+
.. note::
3130

32-
(my_new_project) :~$ pip install git+https://github.com/SPOpenSource/edgeconnect-python
33-
...
34-
(my_new_project) :~$ pip list
35-
Package Version
36-
--------------------- --------------------------------
37-
certifi 2020.12.5
38-
chardet 4.0.0
39-
idna 2.10
40-
pip 20.0.2
41-
pkg-resources 0.0.0
42-
requests 2.25.1
43-
setuptools 44.0.0
44-
pyedgeconnect 0.13.0a1.dev1+g45fd843.d20210428
45-
urllib3 1.26.4
31+
Going forward, these commands assume you're within a Python 3.7+ venv, or Python 3.7+
32+
is the exclusive Python version installed in regard to referencing
33+
the use of ``pip``.
34+
35+
If that is not the case, you can specifically append
36+
``python3.x -m`` ahead of the ``pip install ...``
4637

4738
Install from PyPI
4839
-------------------
4940

5041
.. code:: bash
5142
5243
$ pip install pyedgeconnect
53-
44+
...
45+
$ pip list
46+
Package Version
47+
----------------------------- --------------------------------
48+
... ...
49+
pyedgeconnect x.y.z
50+
... ...
5451
5552
Install from GitHub
5653
-------------------
5754

5855
To install the most recent version of pyedgeconnect, open an
5956
interactive shell and run:
6057

61-
.. note::
62-
63-
These commands assume you're within a Python 3.9 venv, or Python 3.9
64-
is the exclusive Python version installed in regard to referencing
65-
the use of ``pip``.
66-
67-
If that is not the case, you can specifically append
68-
``python3.9 -m`` ahead of the ``pip install ...``
69-
70-
.. code:: python
58+
.. code:: bash
7159
72-
pip install git+https://github.com/SPOpenSource/edgeconnect-python
60+
$ pip install git+https://github.com/SPOpenSource/edgeconnect-python
61+
...
62+
$ pip list
63+
Package Version
64+
----------------------------- --------------------------------
65+
... ...
66+
pyedgeconnect x.y.z
67+
... ...
7368
7469
To install a specific branch use the @branch syntax
7570

76-
.. code:: python
77-
78-
pip install git+https://github.com/SPOpenSource/edgeconnect-python@<branch_name>
79-
71+
.. code:: bash
8072
73+
$ pip install git+https://github.com/SPOpenSource/edgeconnect-python@<branch_name>
74+
# Install the Development branch
75+
$ pip install git+https://github.com/SPOpenSource/edgeconnect-python@Development
8176
8277
Build Documentation Locally
8378
---------------------------
@@ -87,8 +82,8 @@ to include sphinx and related packages, then in the docs directory run ``make ht
8782

8883
.. code:: bash
8984
90-
git clone https://github.com/SPOpenSource/edgeconnect-python.git
91-
cd edgeconnect-python
92-
pip install .[dev]
93-
cd docs
94-
make html
85+
$ git clone https://github.com/SPOpenSource/edgeconnect-python.git
86+
$ cd edgeconnect-python
87+
$ pip install .[dev]
88+
$ cd docs
89+
$ make html

‎setup.py‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,8 @@
3131
"Topic :: System :: Networking",
3232
"License :: OSI Approved :: MIT License",
3333
"Programming Language :: Python :: 3",
34+
"Programming Language :: Python :: 3.7",
35+
"Programming Language :: Python :: 3.8",
3436
"Programming Language :: Python :: 3.9",
3537
"Programming Language :: Python :: 3 :: Only",
3638
"Operating System :: OS Independent",

0 commit comments

Comments
 (0)