From 99ad21c89628c547379f7f872ec9b5732404bde4 Mon Sep 17 00:00:00 2001 From: Nigel Dokter Date: Sun, 25 Aug 2024 14:55:22 +0200 Subject: [PATCH] added a bit of documentation on how to run tests (#165) * added a bit of documentation on how to run tests * formatting * formatting * formatting * formatting * formatting * formatting --- README.rst | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) diff --git a/README.rst b/README.rst index 9d80b96..5aa9524 100644 --- a/README.rst +++ b/README.rst @@ -293,6 +293,36 @@ To install DSMR Parser: $ pip install dsmr-parser +Development +----------- + +Create a virtualenv and activate it followed by the installation of the dsmr-parser: + +.. code-block:: bash + + python3 -m venv venv + source venv/bin/activate + pip install -e . + +Install tox and run it: + +.. code-block:: bash + + pip install tox + tox + +You should see that the tests have succeeded: + +.. code-block:: text + + ======================================================================================================== 59 passed in 0.91s ======================================================================================================== + py: commands[1]> pylama dsmr_parser test + py: OK (11.55=setup[9.73]+cmd[1.29,0.53] seconds) + congratulations :) (11.69 seconds) + + +Now you can make changes by editing the code and rerunning tox to verify your changes. + Known issues ------------