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 From 961c4233f817617b18950df30c23b54f76060013 Mon Sep 17 00:00:00 2001 From: Yuval Adam <_@yuv.al> Date: Sat, 1 Feb 2020 14:16:47 +0200 Subject: Cleanup README --- README.rst | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) (limited to 'README.rst') diff --git a/README.rst b/README.rst index 90a8744..d19ea16 100644 --- a/README.rst +++ b/README.rst @@ -73,7 +73,7 @@ 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: +Development packages can be installed with ``pipenv``. Unit tests and code formatting tasks can be run with the builtin scripts: .. code-block:: shell @@ -81,7 +81,7 @@ Development packages can be installed with `pipenv`. Unit tests and code formatt $ 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`): +For PyPI releases, follow the build, check and upload scripts. .. code-block:: shell @@ -89,6 +89,7 @@ For PyPI releases, follow the build, check and upload scripts (note that a valid $ 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 ---------- -- cgit v1.3.1