From 4a4f33ebd842f5037cdc691e273bfccf30df4c3e Mon Sep 17 00:00:00 2001 From: Yuval Adam <_@yuv.al> Date: Sat, 1 Feb 2020 14:15:30 +0200 Subject: Add development tools in Pipfile and update README --- README.rst | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) (limited to 'README.rst') diff --git a/README.rst b/README.rst index 0caa030..90a8744 100644 --- a/README.rst +++ b/README.rst @@ -73,9 +73,22 @@ Viewstate HMAC signatures are also supported. In case there are any remaining by Development ----------- +Development packages can be installed with `pipenv`. Unit tests and code formatting tasks can be run with the builtin scripts: + +.. code-block:: shell + + $ pipenv sync -d + $ pipenv run test + $ pipenv run format + +For PyPI releases, follow the build, check and upload scripts (note that a valid PyPI auth token should be defined in `~/.pypirc`): + .. code-block:: shell - $ pytest + $ pipenv run build + $ pipenv run check + $ pipenv run upload + References ---------- -- cgit v1.3.1