Add dev-requirements, packaging instructions in README

This commit is contained in:
Rupus Reinefjord 2021-08-21 18:12:39 +02:00
parent 171374c131
commit d14e35bfb6
4 changed files with 95 additions and 3 deletions

View file

@ -147,3 +147,13 @@ environment.
pip install pip-tools
pip-compile # only necessary when adding/removing a dependency
pip-sync
### Packaging
See [https://packaging.python.org/tutorials/packaging-projects/](https://packaging.python.org/tutorials/packaging-projects/) for detailed info.
0. `pip-sync requirements.txt dev-requirements.txt`
1. Increment `version` in `setup.cfg`.
2. `python3 -m build`
4. `python3 -m twine upload dist/*version*`

3
dev-requirements.in Normal file
View file

@ -0,0 +1,3 @@
-c requirements.txt
build
twine

78
dev-requirements.txt Normal file
View file

@ -0,0 +1,78 @@
#
# This file is autogenerated by pip-compile with python 3.9
# To update, run:
#
# pip-compile dev-requirements.in
#
bleach==4.0.0
# via readme-renderer
build==0.6.0.post1
# via -r dev-requirements.in
certifi==2021.5.30
# via requests
cffi==1.14.6
# via cryptography
charset-normalizer==2.0.4
# via requests
colorama==0.4.4
# via twine
cryptography==3.4.7
# via secretstorage
docutils==0.17.1
# via readme-renderer
idna==3.2
# via requests
importlib-metadata==4.6.4
# via
# keyring
# twine
jeepney==0.7.1
# via
# keyring
# secretstorage
keyring==23.1.0
# via twine
packaging==21.0
# via
# bleach
# build
pep517==0.11.0
# via build
pkginfo==1.7.1
# via twine
pycparser==2.20
# via cffi
pygments==2.10.0
# via readme-renderer
pyparsing==2.4.7
# via packaging
readme-renderer==29.0
# via twine
requests==2.26.0
# via
# requests-toolbelt
# twine
requests-toolbelt==0.9.1
# via twine
rfc3986==1.5.0
# via twine
secretstorage==3.3.1
# via keyring
six==1.16.0
# via
# bleach
# readme-renderer
tomli==1.2.1
# via
# build
# pep517
tqdm==4.62.1
# via twine
twine==3.4.2
# via -r dev-requirements.in
urllib3==1.26.6
# via requests
webencodings==0.5.1
# via bleach
zipp==3.5.0
# via importlib-metadata

View file

@ -1,7 +1,8 @@
#
# This file is autogenerated by pip-compile
# This file is autogenerated by pip-compile with python 3.9
# To update, run:
#
# pip-compile
# pip-compile requirements.in
#
python-gnupg==0.4.6 # via -r requirements.in
python-gnupg==0.4.6
# via -r requirements.in