Skip to content

Commit

Permalink
[QMI-111] Updated Python versions also in installation.rst and `TES…
Browse files Browse the repository at this point in the history
…TING.md` and a couple of other updates on e.g. installation text and CI configuration files.
  • Loading branch information
Henri Ervasti committed Oct 17, 2024
1 parent abdf6c9 commit ffe5c14
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 11 deletions.
15 changes: 8 additions & 7 deletions TESTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ In any case, both tools can be run from the command line:
Unit tests
----------

Unit tests are executed in the CI environment against different Python versions: 3.9 and 3.10. Code coverage of
Unit tests are executed in the CI environment against different Python versions: 3.10, 3.11 and 3.12. Code coverage of
the tests is computed using [Coverage.py](https://coverage.readthedocs.io/en/coverage-5.3.1/). To run the tests
locally, use:
```zsh
Expand All @@ -44,16 +44,18 @@ to the repository.

The pipelines are configured in `.github\workflows` and consists of four files:

1. github-ci.yml
2. pull_request.yml
3. schedule-full-ci-test-main.yml
4. python_publish.yml
1. push-ci.yml
2. pull_request-ci.yml
3. scheduled-full-ci.yml
4. pypi_publish.yml

with a support file `reusable-ci-workflows.yml`.

In the first three workflows, the following tests are performed:
- The code quality and maintainability analyses and unit-test coverage are performed, as these metrics are considered as quality indicators for the code base (which includes
tests).
- Unit-tests are performed and the coverage is calculated.
- On push to a branch, tests are executing only with Python 3.11. When changes are pushed to a pull request, the tests are rerun parallel also with Python 3.9 and 3.10. With the 3.10 version, the quality badges are created.
- On push to a branch, tests are executing only with Python 3.11. When changes are pushed to a pull request, the tests are rerun parallel also with Python 3.10, 3.11 and 3.12. With the 3.11 version, the quality badges are created.

The fourth workflow packages the source code into an installable Python package.

Expand All @@ -64,7 +66,6 @@ The following limits are defined for code quality and maintainability metrics:

- Pylint score: at least 9.0
- Mypy: 0 errors
- Cyclomatic complexity: at most 30
- Code coverage: at least 90%

If any of the metrics does not comply to the set thresholds, the corresponding job fails.
6 changes: 2 additions & 4 deletions documentation/sphinx/source/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,17 +7,15 @@ While it is possible to install QMI by checking out the repository, for normal u

.. code-block:: shell
pip install git+https://github.com/QuTech-Delft/[email protected]#egg=qmi
Read the ``README.md`` of the project for more detailed installation procedure.
pip install qmi
------------
Dependencies
------------

.. rubric:: Python version

QMI depends on Python 3.9 or newer.
QMI depends on Python 3.10 or newer.

.. rubric:: Python packages

Expand Down

0 comments on commit ffe5c14

Please sign in to comment.