From 0270b61d157bee842a4dade8f7484f4265167adc Mon Sep 17 00:00:00 2001 From: Nigel Dokter Date: Sun, 25 Aug 2024 14:43:37 +0200 Subject: [PATCH 1/7] added a bit of documentation on how to run tests --- README.rst | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/README.rst b/README.rst index 9d80b96..2d1fed7 100644 --- a/README.rst +++ b/README.rst @@ -293,6 +293,32 @@ To install DSMR Parser: $ pip install dsmr-parser +Development +----------- + +Create a virtualenv and activate it followed by the installation of the dsmr-parser: +``` +python3 -m venv venv +source venv/bin/activate +pip install -e . +``` + +Install tox and run it: +``` +pip install tox +tox +``` + +You should see that the tests have succeeded: +``` +======================================================================================================== 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 ------------ From 26563c8e7e584db89966932463dddfb3b4872313 Mon Sep 17 00:00:00 2001 From: Nigel Dokter Date: Sun, 25 Aug 2024 14:47:24 +0200 Subject: [PATCH 2/7] formatting --- README.rst | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.rst b/README.rst index 2d1fed7..f2e8266 100644 --- a/README.rst +++ b/README.rst @@ -297,6 +297,7 @@ Development ----------- Create a virtualenv and activate it followed by the installation of the dsmr-parser: + ``` python3 -m venv venv source venv/bin/activate @@ -304,12 +305,14 @@ pip install -e . ``` Install tox and run it: + ``` pip install tox tox ``` You should see that the tests have succeeded: + ``` ======================================================================================================== 59 passed in 0.91s ======================================================================================================== py: commands[1]> pylama dsmr_parser test From 04c4f6824295700aa4cdfa01d25f5c7fef29f3f6 Mon Sep 17 00:00:00 2001 From: Nigel Dokter Date: Sun, 25 Aug 2024 14:48:53 +0200 Subject: [PATCH 3/7] formatting --- README.rst | 20 +++++++++----------- 1 file changed, 9 insertions(+), 11 deletions(-) diff --git a/README.rst b/README.rst index f2e8266..a283072 100644 --- a/README.rst +++ b/README.rst @@ -298,27 +298,25 @@ Development Create a virtualenv and activate it followed by the installation of the dsmr-parser: -``` -python3 -m venv venv -source venv/bin/activate -pip install -e . -``` +.. code-block:: bash + python3 -m venv venv + source venv/bin/activate + pip install -e . Install tox and run it: -``` -pip install tox -tox -``` +.. code-block:: bash + pip install tox + tox You should see that the tests have succeeded: -``` +.. code-block:: ======================================================================================================== 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. From 9a3d7e2a857e7d0e2a90d2e8b663bde8d0eb4553 Mon Sep 17 00:00:00 2001 From: Nigel Dokter Date: Sun, 25 Aug 2024 14:49:26 +0200 Subject: [PATCH 4/7] formatting --- README.rst | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.rst b/README.rst index a283072..293fd7b 100644 --- a/README.rst +++ b/README.rst @@ -299,6 +299,7 @@ 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 . @@ -306,12 +307,14 @@ Create a virtualenv and activate it followed by the installation of the dsmr-par Install tox and run it: .. code-block:: bash + pip install tox tox You should see that the tests have succeeded: .. code-block:: + ======================================================================================================== 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) From a73585c862e4a0649e992e241ec08e7c812f2db6 Mon Sep 17 00:00:00 2001 From: Nigel Dokter Date: Sun, 25 Aug 2024 14:50:38 +0200 Subject: [PATCH 5/7] formatting --- README.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.rst b/README.rst index 293fd7b..0a04fae 100644 --- a/README.rst +++ b/README.rst @@ -313,7 +313,7 @@ Install tox and run it: You should see that the tests have succeeded: -.. code-block:: +.. code-block:: plaintext ======================================================================================================== 59 passed in 0.91s ======================================================================================================== py: commands[1]> pylama dsmr_parser test From 34f419d10fb5962e1af755eb472f8fb794b49980 Mon Sep 17 00:00:00 2001 From: Nigel Dokter Date: Sun, 25 Aug 2024 14:51:17 +0200 Subject: [PATCH 6/7] formatting --- README.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.rst b/README.rst index 0a04fae..f8fb731 100644 --- a/README.rst +++ b/README.rst @@ -313,7 +313,7 @@ Install tox and run it: You should see that the tests have succeeded: -.. code-block:: plaintext +.. code-block:: text ======================================================================================================== 59 passed in 0.91s ======================================================================================================== py: commands[1]> pylama dsmr_parser test From 6c4f058cf681630aba36e0cc8a2500c7e885cd53 Mon Sep 17 00:00:00 2001 From: Nigel Dokter Date: Sun, 25 Aug 2024 14:51:36 +0200 Subject: [PATCH 7/7] formatting --- README.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.rst b/README.rst index f8fb731..5aa9524 100644 --- a/README.rst +++ b/README.rst @@ -315,10 +315,10 @@ 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) + ======================================================================================================== 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.