Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

added a bit of documentation on how to run tests #165

Merged
merged 7 commits into from
Aug 25, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 30 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
------------

Expand Down
Loading