76 lines (49 loc) · 1017 Bytes

Development

install

Create, activate, deactivate a virtual environment:

python -m venv venv

.\venv\Scripts\activate  # windows
source venv/bin/activate # linux

deactivate

Install dependencies:

pip install -r requirements.txt

To update requirements.txt, use https://azurda.github.io/

Test

python -m unittest -v

Format

ruff format

To test whether the library works on different versions of Python, use pyenv.

Publish

Format the code:
```
ruff format
```
Update the version number in setup.py using semantic versioning.
Run the unit tests and check whether all tests pass:
```
python -m unittest
```
Commit and push the changes to GitHub.
Add a version tag:
```
git tag v1.2.3
git push --tag
```
Clear the dist folder
Build the library:
```
python -m build
```
Publish on PyPI:
```
twine check dist/*
twine upload dist/*
```