From ffe5c14a3b5fca7ed5dcd8a566dc542733ab644b Mon Sep 17 00:00:00 2001 From: Henri Ervasti Date: Thu, 17 Oct 2024 17:54:01 +0200 Subject: [PATCH] [QMI-111] Updated Python versions also in `installation.rst` and `TESTING.md` and a couple of other updates on e.g. installation text and CI configuration files. --- TESTING.md | 15 ++++++++------- documentation/sphinx/source/installation.rst | 6 ++---- 2 files changed, 10 insertions(+), 11 deletions(-) diff --git a/TESTING.md b/TESTING.md index 899d3b2..256ddee 100644 --- a/TESTING.md +++ b/TESTING.md @@ -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 @@ -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. @@ -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. diff --git a/documentation/sphinx/source/installation.rst b/documentation/sphinx/source/installation.rst index 6d22103..fb10e09 100644 --- a/documentation/sphinx/source/installation.rst +++ b/documentation/sphinx/source/installation.rst @@ -7,9 +7,7 @@ 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/QMI.git@v0.43.0-beta.0#egg=qmi - -Read the ``README.md`` of the project for more detailed installation procedure. + pip install qmi ------------ Dependencies @@ -17,7 +15,7 @@ Dependencies .. rubric:: Python version -QMI depends on Python 3.9 or newer. +QMI depends on Python 3.10 or newer. .. rubric:: Python packages