Use nox (#223)

* 🧑‍💻 Add term cov

* 🔥 Remove tox.ini

* 🔧 Add noxfile

* 🔧 Replace tox with nox

* 👷 Use nox in CI

* 🧑‍💻 Reorder sessions

* 🦺 Check noxfile.py

* 👷 Fix CI

* 👷 Fix python version

.github/pull_request_template.md

@@ -1,6 +1,6 @@
 Before submitting, please check the following:
 
-- Make sure you have tests for the new code and that test passes (run `tox`)
+- Make sure you have tests for the new code and that test passes (run `nox`)
 - If applicable, add a line to the [unreleased] part of CHANGELOG.md, following [keep-a-changelog](https://keepachangelog.com/en/1.0.0/).
 - Format added code by `ruff`
  - See `CONTRIBUTING.md` for more details

.github/workflows/ci.yml

@@ -26,16 +26,14 @@ jobs:
  steps:
  - uses: actions/checkout@v4
 
- - name: Set up Python ${{ matrix.python }}
- uses: actions/setup-python@v5
+ - uses: actions/setup-python@v5
  with:
  python-version: ${{ matrix.python }}
 
- - name: Upgrade pip
- run: python -m pip install --upgrade pip
+ - run: python -m pip install --upgrade pip
 
- - name: Install tox
- run: pip install tox tox-gh-actions
+ - name: Setup nox
+ # Keep in sync with requirements-dev.txt
+ uses: wntrblm/[email protected]
 
- - name: Run tox
- run: tox
+ - run: nox --python ${{ matrix.python }}

.github/workflows/cov.yml

@@ -25,7 +25,7 @@ jobs:
  run: pip install .[dev]
 
  - name: Run pytest
- run: pytest --cov=./graphix --cov-report=xml
+ run: pytest --cov=./graphix --cov-report=xml --cov-report=term
 
  - name: Upload coverage reports to Codecov
  uses: codecov/[email protected]

noxfile.py

@@ -0,0 +1,21 @@
+"""Run tests with nox."""
+
+from __future__ import annotations
+
+import nox
+from nox import Session
+
+
+@nox.session(python=["3.8", "3.9", "3.10", "3.11", "3.12"])
+def tests_minimal(session: Session) -> None:
+ """Run the test suite with minimal dependencies."""
+ session.install("-e", ".")
+ session.install("pytest", "pytest-mock", "psutil")
+ session.run("pytest")
+
+
+@nox.session(python=["3.8", "3.9", "3.10", "3.11", "3.12"])
+def tests(session: Session) -> None:
+ """Run the test suite with full dependencies."""
+ session.install("-e", ".[dev]")
+ session.run("pytest")

pyproject.toml

@@ -108,6 +108,7 @@ files = [
  "graphix/states.py",
  "graphix/type_utils.py",
  "graphix/_db.py",
+ "noxfile.py",
  "tests/conftest.py",
  "tests/test_clifford.py",
  "tests/test_db.py",
@@ -133,6 +134,7 @@ include = [
  "graphix/states.py",
  "graphix/type_utils.py",
  "graphix/_db.py",
+ "noxfile.py",
  "tests/conftest.py",
  "tests/test_clifford.py",
  "tests/test_db.py",

requirements-dev.txt

@@ -8,11 +8,12 @@ types-networkx
 types-psutil
 
 # Tests
+# Keep in sync with CI
+nox==2024.10.09
 psutil
 pytest
 pytest-cov
 pytest-mock
-tox
 
 # Optional dependencies
 qiskit>=1.0