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

Update README.md with dev docs.

Browse Source
This commit is contained in:
UpstreamData
2024-03-29 11:17:39 -06:00
committed by GitHub
parent 8bc8f6f178
commit a511fabd9c
1 changed files with 6 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@@ -23,6 +23,8 @@ 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/)
`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
``` ```
@@ -36,6 +38,10 @@ It is recommended to install `pyasic` in a [virtual environment](https://realpyt
`python -m pip install .` or `poetry install` `python -m pip install .` or `poetry install`
##### Additional Developer Setup
`poetry install --with dev`
`pre-commit install`
--- ---
## Getting started ## Getting started