summaryrefslogtreecommitdiff
path: root/README.rst
diff options
context:
space:
mode:
authorYuval Adam <_@yuv.al>2020-02-01 14:15:30 +0200
committerYuval Adam <_@yuv.al>2020-02-01 14:15:30 +0200
commit4a4f33ebd842f5037cdc691e273bfccf30df4c3e (patch)
tree2e3e0c85272d7eb352b558fbba1784473041a494 /README.rst
parent1b5fadb7e676bf5036f73319359cd0e1c1ac3b95 (diff)
Add development tools in Pipfile and update README
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst15
1 files changed, 14 insertions, 1 deletions
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
----------