noxfile.py

# /// script
# requires-python = ">=3.11"
# dependencies = [
#     "python-dotenv",
#     "nox",
# ]
# ///
"""Main nox automation script."""

import pathlib
from os import getenv

import nox
import nox.command
from dotenv import load_dotenv
from nox.sessions import Session

load_dotenv()
EXTERNAL = getenv("EXTERNAL", "True") == "True"
KEEP_VENV = getenv("KEEP_VENV", "True") == "True"
PORT_NUMBER = int(getenv("PORT_NUMBER", "8000"))
PYTHON_VERSION = (
    pathlib.Path(".python-version").read_text().strip()
)  # read python version from .python-version file
python_version = PYTHON_VERSION


BACKEND = "uv"  # or "venv" or "conda"

name = pathlib.Path().name  # get the project name from the current directory

# Nox sessions to run by default

nox.options.sessions = [
    "tests",  # to run tests
    # "docker",  # to build & run docker container
    # "setup_pre_commit",  # to setup pre-commit hooks
    # "dev",  # to run the project locally
]


@nox.session(python=python_version, venv_backend=BACKEND, reuse_venv=KEEP_VENV)
def tests(session: Session) -> None:
    """Run the pytest test suite."""
    try:
        session.run(
            "pytest",
            "--cov",
            env={"COVERAGE_FILE": ".coverage"},
            external=EXTERNAL,
            success_codes=[0, 5],
        )
    finally:
        session.run("coverage", "report", "--fail-under=0", "--show-missing")


# non-default sessions to run


@nox.session(python=python_version, venv_backend=BACKEND, reuse_venv=KEEP_VENV)
def docker_run(session: nox.Session, docker_name: str) -> None:
    """Run the project dev environment in docker container."""
    session.run(
        "docker",
        "run",
        "--name",
        name,
        "-p",
        str(PORT_NUMBER) + ":" + str(PORT_NUMBER),
        "-d",
        docker_name,
    )


@nox.session(python=python_version, venv_backend=BACKEND, reuse_venv=KEEP_VENV)
def docker(session: nox.Session) -> None:
    """Build & Run the project dev environment in docker container."""
    session.log("Building the docker image: %s", name)
    session.run("docker", "build", "-t", name, ".", external=EXTERNAL)
    docker_run(session, name)


@nox.session(python=python_version, venv_backend=BACKEND, reuse_venv=KEEP_VENV)
def docker_stop(session: nox.Session, docker_name: str = "") -> None:
    """Stop the running docker container."""
    session.log("Stopping the docker container: %s", docker_name)
    docker_name = name if docker_name == "" else docker_name
    session.run("docker", "stop", docker_name, external=EXTERNAL)


@nox.session(python=python_version, venv_backend=BACKEND, reuse_venv=KEEP_VENV)
def docker_start(session: nox.Session, docker_name: str = "") -> None:
    """Start the stopped docker container."""
    docker_name = name if docker_name == "" else docker_name
    session.log("Starting the docker container: %s", docker_name)
    session.run("docker", "start", docker_name, external=EXTERNAL)


@nox.session(python=python_version, venv_backend=BACKEND, reuse_venv=KEEP_VENV)
def docker_rm(session: nox.Session, docker_name: str = "") -> None:
    """Remove the docker container."""
    docker_name = name if docker_name == "" else docker_name
    session.log("Stopping the docker container if any: %s", docker_name)
    docker_stop(session, docker_name)
    session.log("Removing the docker container: %s", docker_name)
    session.run("docker", "rm", docker_name, external=EXTERNAL)


@nox.session(python=python_version, venv_backend=BACKEND, reuse_venv=KEEP_VENV)
def docker_rmi(session: nox.Session, docker_name: str = "") -> None:
    """Remove the docker image."""
    session.log("Removing the docker container if any: %s", docker_name)
    docker_rm(session, docker_name)
    session.log("Removing the docker image: %s", docker_name)
    docker_name = name if docker_name == "" else docker_name
    session.run("docker", "rmi", docker_name, external=EXTERNAL)


@nox.session(python=python_version, venv_backend=BACKEND, reuse_venv=KEEP_VENV)
def dev(session: nox.Session) -> None:
    """Run the project dev environment locally."""
    session.run("uv", "sync", "--all-groups")
    session.run("uv", "run", "./main.py", external=EXTERNAL)


@nox.session(python=python_version, venv_backend=BACKEND, reuse_venv=KEEP_VENV)
def setup_pre_commit(session: nox.Session) -> None:
    """Set up pre-commit hooks."""
    session.run("pre-commit", "install", external=EXTERNAL)
    session.run("pre-commit", "install", "-t", "pre-push", external=EXTERNAL)