docs: update dev setup.

This commit is contained in:
UpstreamData
2024-03-29 11:19:17 -06:00
committed by GitHub
parent a511fabd9c
commit 70b45f40f5

View File

@@ -23,8 +23,10 @@ Welcome to `pyasic`! `pyasic` uses an asynchronous method of communicating with
## 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:
- [pypoetry](https://python-poetry.org/)
`poetry install`
- [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
- [pyenv-virtualenv](https://github.com/pyenv/pyenv-virtualenv): [pyenv](https://github.com/pyenv/pyenv) plugin for managing virtualenvs
```
@@ -39,8 +41,10 @@ It is recommended to install `pyasic` in a [virtual environment](https://realpyt
`python -m pip install .` or `poetry install`
##### Additional Developer Setup
`poetry install --with dev`
`pre-commit install`
```
poetry install --with dev
pre-commit install
```
---
## Getting started