Skip to content

Commit

Permalink
build: added tabulate to pipenv dev dependencies, updated the readme …
Browse files Browse the repository at this point in the history
…to create markdown table
  • Loading branch information
FedericoTartarini committed Oct 30, 2024
1 parent 7076dd0 commit 90444d2
Show file tree
Hide file tree
Showing 4 changed files with 31 additions and 17 deletions.
1 change: 1 addition & 0 deletions Pipfile
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ pytest = "*"
requests = "*"
pandas = "*"
pydantic = "*"
tabulate = "*"

[requires]
python_version = "3.12"
Expand Down
31 changes: 20 additions & 11 deletions Pipfile.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

13 changes: 8 additions & 5 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -118,20 +118,23 @@ See file in `.github/workflows/` for more information.

Test (For developers)
=====================
To run all the test cases with scripts_test_result.py script after any changes. The test cases come from `validation-data-comfort-models`_
Run all the test cases with scripts_test_result.py after making any changes. The test cases come from an online repository.

.. _validation-data-comfort-models: https://github.com/FedericoTartarini/validation-data-comfort-models

```bash
python ./tests/scripts_test_result.py [env]
python ./tests/scripts_test_result.py py311
```
`env` is used to specify the Python version of test environment. It could be py39, py310, py311, py312. The scripts will call tox command and summarize test results into a markdown table.
The following markdown table will be updated once you run the scriput.

You can also specify another version of Python like one of the following py39, py310, py311, py312.
You must have this Python version installed in your system.
The scripts will call tox command and summarize test results into a markdown table.
The following markdown table will be updated once you run the script.

----------------------------
| Test File | Result |
|:------------------------------|:---------|
| test_a_pmv.py | PASSED |
| test_a_pmv.py | FAILED |
| test_adaptive_ashrae.py | PASSED |
| test_adaptive_en.py | PASSED |
| test_ankle_draft.py | PASSED |
Expand Down
3 changes: 2 additions & 1 deletion tox.ini
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,9 @@ deps =
scipy
numba
pandas
tabulate
commands =
{posargs:pytest --cov --cov-report=term-missing -vv tests --ignore=./tests/scripts_test_result.py}
{posargs:pytest --cov --cov-report=term-missing -vv tests --ignore=./tests/scripts_test_result.py}

[testenv:docs]
usedevelop = true
Expand Down

0 comments on commit 90444d2

Please sign in to comment.