summaryrefslogtreecommitdiff
path: root/README.rst
diff options
context:
space:
mode:
authorYuval Adam <_@yuv.al>2020-02-01 14:26:42 +0200
committerYuval Adam <_@yuv.al>2020-02-01 14:26:42 +0200
commit5b39d49ea52d3ffdd0868a1a1f1d6c3b8d0198ec (patch)
tree9128fbe380333a05bc0d7f0ac5b7f43ccc101825 /README.rst
parent9ad1d77d4f4e82cf6286efc950261b1b01ab9057 (diff)
parent961c4233f817617b18950df30c23b54f76060013 (diff)
Merge branch 'master' into colors
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst16
1 files changed, 15 insertions, 1 deletions
diff --git a/README.rst b/README.rst
index 0caa030..d19ea16 100644
--- a/README.rst
+++ b/README.rst
@@ -73,9 +73,23 @@ 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.
+
.. code-block:: shell
- $ pytest
+ $ pipenv run build
+ $ pipenv run check
+ $ pipenv run upload
+
+Note that for uploading a new package version, a valid PyPI auth token should be defined in ``~/.pypirc``.
References
----------