Skip to content

Commit

Permalink
Clarify minimum Python version management docs (#435)
Browse files Browse the repository at this point in the history
  • Loading branch information
michaeldiamant committed Jul 8, 2022
1 parent 52396c2 commit d995a89
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 1 deletion.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,9 @@ PyTeal provides high level, functional programming style abstractions over TEAL

PyTeal requires Python version >= 3.10.

To manage multiple Python versions use tooling like [pyenv](https://github.com/pyenv/pyenv).
If your operating system (OS) Python version < 3.10, we recommend:
* Rather than override the OS Python version, install Python >= 3.10 alongside the OS Python version.
* Use [pyenv](https://github.com/pyenv/pyenv#installation) or similar tooling to manage multiple Python versions.

### Recommended: Install from PyPi

Expand Down
7 changes: 7 additions & 0 deletions docs/installation.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,13 @@
Install PyTeal
==============

PyTeal requires Python version >= 3.10.

If your operating system (OS) Python version < 3.10, we recommend:

* Rather than override the OS Python version, install Python >= 3.10 alongside the OS Python version.
* Use `pyenv <https://github.com/pyenv/pyenv#installation>`_ or similar tooling to manage multiple Python versions.

The easiest way of installing PyTeal is using :code:`pip` : ::

$ pip3 install pyteal
Expand Down

0 comments on commit d995a89

Please sign in to comment.