noxfile.py

import nox

# Define which Python versions to test with
PYTHON_VERSIONS = ["3.9", "3.10", "3.11", "3.12", "3.13"]
LATEST_PYTHON_VERSION = PYTHON_VERSIONS[-1]

# Default sessions (these will be executed in Github Actions)
# Maintain a clear separation between code checking and code altering tasks (don't add format)
nox.options.sessions = ["lint", "tests"]
# nox.options.reuse_existing_virtualenvs = True # TODO: Check if necessary


@nox.session(python=PYTHON_VERSIONS)
def tests(session):
    """Run the test suite."""
    session.install("pytest", "pytest-asyncio", "pytest-docker", "pytest-cov")
    session.install(".")
    session.run("pytest", "--cov", "--cov-report=term-missing")


@nox.session(python=LATEST_PYTHON_VERSION)
def lint(session):
    """Lint the codebase using flake8."""
    session.install("flake8")
    session.run("flake8", "src/dataclay", "tests")


@nox.session(python=LATEST_PYTHON_VERSION)
def format(session):
    """Automatically format code with black and isort."""
    session.install("black", "isort")
    # Run isort before black
    session.run("isort", "--gitignore", ".")
    session.run("black", ".")


@nox.session(python=LATEST_PYTHON_VERSION)
def mypy(session):
    """Run type checks using mypy."""
    session.install(".")
    session.install("mypy")
    session.run("mypy", "src/dataclay")


@nox.session(python=LATEST_PYTHON_VERSION)
def safety(session):
    """Check for security vulnerabilities."""
    session.install(".")
    session.install("safety")
    session.run("safety", "check")


@nox.session(default=False)
def dev(session: nox.Session) -> None:
    """
    Set up a python development environment for the project at ".venv".
    """
    session.install("virtualenv")
    session.run("virtualenv", ".venv", silent=True)
    session.run(".venv/bin/pip", "install", "-e", ".[telemetry,dev]", external=True)


# TODO: Check https://nox.thea.codes/en/stable/cookbook.html#the-auto-release