CAT_TOM/pyasic
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: update index and readme.

Browse Source
This commit is contained in:
upstreamdata
2024-04-19 21:43:22 -06:00
committed by Upstream Data
parent 75a3a466a3
commit 385cca6fc0
2 changed files with 14 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@@ -24,16 +24,20 @@ Welcome to `pyasic`! `pyasic` uses an asynchronous method of communicating with
It is recommended to install `pyasic` in a [virtual environment](https://realpython.com/python-virtual-environments-a-primer/#what-other-popular-options-exist-aside-from-venv) to isolate it from the rest of your system. Options include: It is recommended to install `pyasic` in a [virtual environment](https://realpython.com/python-virtual-environments-a-primer/#what-other-popular-options-exist-aside-from-venv) to isolate it from the rest of your system. Options include:
- [pypoetry](https://python-poetry.org/): the reccommended way, since pyasic already uses it by default - [pypoetry](https://python-poetry.org/): the reccommended way, since pyasic already uses it by default
```
```
poetry install poetry install
``` ```
- [venv](https://docs.python.org/3/library/venv.html): included in Python standard library but has fewer features than other options - [venv](https://docs.python.org/3/library/venv.html): included in Python standard library but has fewer features than other options
- [pyenv-virtualenv](https://github.com/pyenv/pyenv-virtualenv): [pyenv](https://github.com/pyenv/pyenv) plugin for managing virtualenvs - [pyenv-virtualenv](https://github.com/pyenv/pyenv-virtualenv): [pyenv](https://github.com/pyenv/pyenv) plugin for managing virtualenvs
```
```
pyenv install <python version number> pyenv install <python version number>
pyenv virtualenv <python version number> <env name> pyenv virtualenv <python version number> <env name>
pyenv activate <env name> pyenv activate <env name>
``` ```
- [conda](https://docs.conda.io/en/latest/) - [conda](https://docs.conda.io/en/latest/)
##### Installing `pyasic` ##### Installing `pyasic`

5
docs/index.md
View File

@@ -22,6 +22,11 @@ Welcome to `pyasic`! `pyasic` uses an asynchronous method of communicating with
## Installation ## Installation
It is recommended to install `pyasic` in a [virtual environment](https://realpython.com/python-virtual-environments-a-primer/#what-other-popular-options-exist-aside-from-venv) to isolate it from the rest of your system. Options include: It is recommended to install `pyasic` in a [virtual environment](https://realpython.com/python-virtual-environments-a-primer/#what-other-popular-options-exist-aside-from-venv) to isolate it from the rest of your system. Options include:
- [pypoetry](https://python-poetry.org/): the reccommended way, since pyasic already uses it by default
```
poetry install
```
- [venv](https://docs.python.org/3/library/venv.html): included in Python standard library but has fewer features than other options - [venv](https://docs.python.org/3/library/venv.html): included in Python standard library but has fewer features than other options
- [pyenv-virtualenv](https://github.com/pyenv/pyenv-virtualenv): [pyenv](https://github.com/pyenv/pyenv) plugin for managing virtualenvs - [pyenv-virtualenv](https://github.com/pyenv/pyenv-virtualenv): [pyenv](https://github.com/pyenv/pyenv) plugin for managing virtualenvs