nox-uv 0.1.0__tar.gz

nox_uv-0.1.0/.editorconfig

@@ -0,0 +1,7 @@
+# For information about this file, see: https://editorconfig.org/
+root = true
+
+# For ease of fitting multiple editor panes side by side consistently, set all files types to use
+# the same relaxed max line length permitted in PEP 8.
+[*]
+max_line_length = 99

nox_uv-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,48 @@
+name: CI
+
+on: [push, pull_request]
+
+env:
+  UV_VERSION: "0.6.9"
+
+jobs:
+  test:
+    runs-on: ubuntu-24.04
+    strategy:
+      matrix:
+        python-version: [ "3.9", "3.10", "3.11", "3.12", "3.13" ]
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+        # Caching is enabled by default for GitHub-hosted runners:
+        #   https://github.com/astral-sh/setup-uv?tab=readme-ov-file#enable-caching
+        with:
+          version: ${{ env.UV_VERSION }}
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install Package
+        run: uv sync --locked --no-default-groups
+      - name: Test with Nox
+        run: uv run nox -s test-${{ matrix.python-version }}
+  quality:
+    runs-on: ubuntu-24.04
+    strategy:
+      matrix:
+        nox-session: ["lint", "type_check"]
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          version: ${{ env.UV_VERSION }}
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version-file: ".python-version"
+      - name: Install dependencies
+        run: uv sync --locked --no-default-groups
+      - name: Test with Nox
+        run: uv run nox -s ${{ matrix.nox-session }}

nox_uv-0.1.0/.github/workflows/container.yml

@@ -0,0 +1,13 @@
+name: container
+
+on: [push, pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-24.04
+    steps:
+      - uses: actions/checkout@v4
+      - name: Build Container Image
+        uses: docker/build-push-action@v6
+        with:
+          push: false

nox_uv-0.1.0/.gitignore

@@ -0,0 +1,12 @@
+.vscode
+.idea
+.mypy_cache
+.nox
+.pytest_cache
+dist
+htmlcov
+__pycache__
+*.pyc
+*.egg-info
+.coverage
+.coverage.*

nox_uv-0.1.0/.python-version

@@ -0,0 +1 @@
+3.12

nox_uv-0.1.0/Dockerfile

@@ -0,0 +1,97 @@
+# Use a multi-stage build to reduce the size of the final image.
+#   This example is optimized to reduce final image size rather than for simplicity.
+# Using a -slim image also greatly reduces image size.
+# It is possible to use -alpine images instead to further reduce image size, but this comes
+# with several important caveats.
+#   - Alpine images use MUSL rather than GLIBC (as used in the default Debian-based images).
+#   - Most Python packages that require C code are tested against GLIBC, so there could be
+#     subtle errors when using MUSL.
+#   - These Python packages usually only provide binary wheels for GLIBC, so the packages
+#     will need to be recompiled fully within the container images, increasing build times.
+FROM python:3.11-slim-bookworm AS python_builder
+
+# Pin uv to a specific version to make container builds reproducible.
+ENV UV_VERSION=0.6.9
+
+# Set ENV variables that make Python more friendly to running inside a container.
+ENV PYTHONDONTWRITEBYTECODE=1
+ENV PYTHONBUFFERED=1
+
+# By default, pip caches copies of downloaded packages from PyPI. These are not useful within
+# a contain image, so disable this to reduce the size of images.
+ENV PIP_NO_CACHE_DIR=1
+ENV WORKDIR=/src
+
+WORKDIR ${WORKDIR}
+
+# Install any system dependencies required to build wheels, such as C compilers or system packages
+# For example:
+#RUN apt-get update && apt-get install -y \
+#    gcc \
+#    && rm -rf /var/lib/apt/lists/*
+
+# Install uv into the global environment to isolate it from the venv it creates.
+RUN pip install "uv==${UV_VERSION}"
+
+# Pre-download/compile wheel dependencies into a virtual environment.
+# Doing this in a multi-stage build allows omitting compile dependencies from the final image.
+# This must be the same path that is used in the final image as the virtual environment has
+# absolute symlinks in it.
+ENV VIRTUAL_ENV=/opt/venv
+RUN python -m venv ${VIRTUAL_ENV}
+ENV PATH="${VIRTUAL_ENV}/bin:${PATH}"
+
+# Copy in project dependency specification.
+COPY pyproject.toml uv.lock ./
+
+# Don't install the package itself with uv because it will install it as an editable install.
+RUN uv sync --locked --no-default-groups --no-install-project
+
+# Copy in source files.
+COPY README.md ./
+COPY src src
+
+# Manually build/install the package.
+RUN uv build && \
+    pip install dist/*.whl
+
+## Final Image
+# The image used in the final image MUST match exactly to the python_builder image.
+FROM python:3.11-slim-bookworm
+
+ENV PYTHONDONTWRITEBYTECODE=1
+ENV PYTHONBUFFERED=1
+ENV PIP_NO_CACHE_DIR=1
+ENV VIRTUAL_ENV=/opt/venv
+
+ENV HOME=/home/user
+ENV APP_HOME=${HOME}/app
+
+# Create the home directory for the new user.
+RUN mkdir -p ${HOME}
+
+# Create the user so the program doesn't run as root. This increases security of the container.
+RUN groupadd -r user && \
+    useradd -r -g user -d ${HOME} -s /sbin/nologin -c "Container image user" user
+
+# Setup application install directory.
+RUN mkdir ${APP_HOME}
+
+# If you use Docker Compose volumes, you might need to create the directories in the image,
+# otherwise when Docker Compose creates them they are owned by the root user and are inaccessible
+# by the non-root user. See https://github.com/docker/compose/issues/3270
+
+WORKDIR ${APP_HOME}
+
+# Copy and activate pre-built virtual environment.
+COPY --from=python_builder ${VIRTUAL_ENV} ${VIRTUAL_ENV}
+ENV PATH="${VIRTUAL_ENV}/bin:${PATH}"
+
+# For Python applications that are not installable libraries, you may need to copy in source
+# files here in the final image rather than in the python_builder image.
+
+# Give access to the entire home folder to the new user so that files and folders can be written
+# there. Some packages such as matplotlib, want to write to the home folder.
+RUN chown -R user:user ${HOME}
+
+ENTRYPOINT ["fact"]

nox_uv-0.1.0/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Dan Tebben
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

nox_uv-0.1.0/PKG-INFO

@@ -0,0 +1,34 @@
+Metadata-Version: 2.4
+Name: nox-uv
+Version: 0.1.0
+Summary: Facilitate nox integration with uv for Python projects
+Project-URL: Homepage, https://github.com/dantebben/nox-uv
+Author-email: Dan Tebben <dantebben@gmail.com>
+License-Expression: MIT
+License-File: LICENSE.txt
+Requires-Python: <3.14,>=3.9
+Requires-Dist: nox>=2025.2.9
+Description-Content-Type: text/markdown
+
+## Intro
+
+This is heavliy influcenced by, but much more limited than, 
+[nox-poetry](https://nox-poetry.readthedocs.io).
+
+This is a basic drop-in replacement for `nox.session` of [nox](https://nox.thea.codes/) to be used 
+with the [uv](https://docs.astral.sh/uv/) package manager.
+
+To use, import `session` from `nox-uv` in your `nox-file`.
+
+**NOTE**: All `@session(...)` parameters are keyword-only, no positional parameters are allowed.
+
+**NOTE**: The `default_groups` defined in `pyproject.toml` are _not_ installed by default. The
+user must explicitly list the desired groups in the `uv_groups` parameter. 
+
+## Added parameters
+
+- `uv_groups`: list of `uv` dependency groups
+- `uv_extras`: list of `uv` extras
+- `uv_all_extras`: boolean to install all extras from `pyproject.toml`
+- `uv_all_groups`: boolean to install all dependency groups
+

nox_uv-0.1.0/README.md

@@ -0,0 +1,22 @@
+## Intro
+
+This is heavliy influcenced by, but much more limited than, 
+[nox-poetry](https://nox-poetry.readthedocs.io).
+
+This is a basic drop-in replacement for `nox.session` of [nox](https://nox.thea.codes/) to be used 
+with the [uv](https://docs.astral.sh/uv/) package manager.
+
+To use, import `session` from `nox-uv` in your `nox-file`.
+
+**NOTE**: All `@session(...)` parameters are keyword-only, no positional parameters are allowed.
+
+**NOTE**: The `default_groups` defined in `pyproject.toml` are _not_ installed by default. The
+user must explicitly list the desired groups in the `uv_groups` parameter. 
+
+## Added parameters
+
+- `uv_groups`: list of `uv` dependency groups
+- `uv_extras`: list of `uv` extras
+- `uv_all_extras`: boolean to install all extras from `pyproject.toml`
+- `uv_all_groups`: boolean to install all dependency groups
+

nox_uv-0.1.0/noxfile.py

@@ -0,0 +1,70 @@
+from nox import Session, options, parametrize
+
+from nox_uv import session
+
+options.error_on_external_run = True
+options.reuse_existing_virtualenvs = True
+options.sessions = ["lint", "type_check", "test"]
+
+
+# Including Python 3.9 here just to test when UV_PYTHON_DOWNLOADS=never
+@session(
+    venv_backend="uv",
+    reuse_venv=True,
+    python=["3.9", "3.10", "3.11", "3.12", "3.13"],
+    uv_groups=["test"],
+    uv_all_groups=True,
+)
+def test(s: Session) -> None:
+    s.run(
+        "pytest",
+        *s.posargs,
+    )
+
+
+# For some sessions, set venv_backend="none" to simply execute scripts within the existing Poetry
+# environment. This requires that nox is run within `poetry shell` or using `poetry run nox ...`.
+@session(venv_backend="none")
+@parametrize(
+    "command",
+    [
+        # During formatting, additionally sort imports and remove unused imports.
+        [
+            "ruff",
+            "check",
+            ".",
+            "--select",
+            "I",
+            "--select",
+            "F401",
+            "--extend-fixable",
+            "F401",
+            "--fix",
+        ],
+        ["ruff", "format", "."],
+    ],
+)
+def fmt(s: Session, command: list[str]) -> None:
+    s.run(*command)
+
+
+@session(venv_backend="uv", uv_groups=["lint"])
+@parametrize(
+    "command",
+    [
+        ["ruff", "check", "."],
+        ["ruff", "format", "--check", "."],
+    ],
+)
+def lint(s: Session, command: list[str]) -> None:
+    s.run(*command)
+
+
+@session(venv_backend="none")
+def lint_fix(s: Session) -> None:
+    s.run("ruff", "check", ".", "--extend-fixable", "F401", "--fix")
+
+
+@session(venv_backend="none")
+def type_check(s: Session) -> None:
+    s.run("mypy", "src", "tests", "noxfile.py")

nox_uv-0.1.0/pyproject.toml

@@ -0,0 +1,122 @@
+[project]
+name = "nox-uv"
+version = "0.1.0"
+description = "Facilitate nox integration with uv for Python projects"
+readme = "README.md"
+authors = [
+    { name = "Dan Tebben", email = "dantebben@gmail.com" }
+]
+license = "MIT"
+license-files = ["LICENSE.txt"]
+requires-python = ">=3.9, <3.14"
+dependencies = [
+    "nox>=2025.2.9",
+]
+
+[project.urls]
+Homepage = "https://github.com/dantebben/nox-uv"
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[dependency-groups]
+docs = [
+    "mkdocs>=1.6.1",
+    "mkdocs-gen-files>=0.5.0",
+    "mkdocs-htmlproofer-plugin>=1.3.0",
+    "mkdocs-literate-nav>=0.6.1",
+    "mkdocs-material>=9.6.5",
+    "mkdocstrings[python]>=0.28.2",
+]
+lint = [
+    "ruff>=0.9.7",
+]
+test = [
+    "pytest-cov>=6.0.0",
+    "pytest-randomly>=3.16.0",
+]
+type-check = [
+    "mypy>=1.15.0",
+]
+
+[tool.uv]
+default-groups = [
+    "lint",
+    "test",
+    "type-check",
+]
+
+
+[tool.mypy]
+ignore_missing_imports = true
+strict = true
+# TODO: Remove this when explicit-override is enabled by default in strict mode
+#   https://github.com/python/mypy/issues/17511
+enable_error_code = ["explicit-override"]
+# If certain strict config options are too pedantic for a project,
+# disable them selectively here by setting to false.
+
+[tool.ruff]
+line-length = 99
+src = ["src"]
+# Ruff will automatically exclude all files listed in .gitignore as well as common temporary Python
+# tool directories.
+# To exclude additional folders, use extend-exclude.
+
+[tool.ruff.lint]
+select = [
+    "F", # pyflakes
+    "E", # pycodestyle
+    "I", # isort
+    "N", # pep8-naming
+    "UP", # pyupgrade
+    "RUF", # ruff
+    "B", # flake8-bugbear
+    "C4", # flake8-comprehensions
+    "ISC", # flake8-implicit-str-concat
+    "PIE", # flake8-pie
+    "PT", # flake-pytest-style
+    "PTH", # flake8-use-pathlib
+    "SIM", # flake8-simplify
+    "TID", # flake8-tidy-imports
+]
+extend-ignore = [
+    "RUF005",
+    "RUF012",
+]
+unfixable = [
+    # Disable removing unused imports by default and only enable within nox so editors don't delete
+    # unused imports while the user is in the middle of editing a file on save.
+    "F401",
+]
+
+[tool.ruff.lint.isort]
+force-sort-within-sections = true
+split-on-trailing-comma = false
+# For non-src directory projects, explicitly set top level package names:
+# known-first-party = ["my-app"]
+
+[tool.ruff.lint.flake8-tidy-imports]
+ban-relative-imports = "all"
+
+[tool.ruff.lint.flake8-bugbear]
+extend-immutable-calls = ["typer.Argument"]
+
+[tool.pytest.ini_options]
+addopts = [
+    "--strict-config",
+    "--strict-markers",
+]
+xfail_strict = true
+filterwarnings = [
+    # When running tests, treat warnings as errors (e.g. -Werror).
+    # See: https://docs.pytest.org/en/latest/reference/reference.html#confval-filterwarnings
+    "error",
+    # Add additional warning suppressions as needed here. For example, if a third-party library
+    # is throwing a deprecation warning that needs to be fixed upstream:
+    # "ignore::DeprecationWarning:typer",
+]
+
+[tool.coverage.run]
+branch = true

nox_uv-0.1.0/src/nox_uv/__init__.py

@@ -0,0 +1,106 @@
+from __future__ import annotations
+
+from collections.abc import Sequence
+import functools
+from typing import Any, Callable, TypeVar
+
+import nox
+
+R = TypeVar("R")
+
+Python = Sequence[str] | str | bool | None
+
+
+def session(
+    *args: Any,
+    python: Python | None = None,
+    reuse_venv: bool | None = None,
+    name: str | None = None,
+    venv_backend: Any | None = None,
+    venv_params: Sequence[str] = (),
+    tags: Sequence[str] | None = None,
+    default: bool = True,
+    requires: Sequence[str] | None = None,
+    uv_groups: Sequence[str] = (),
+    uv_extras: Sequence[str] = (),
+    uv_all_extras: bool = False,
+    uv_all_groups: bool = False,
+) -> Callable[..., R]:
+    """Drop-in replacement for the :func:`nox.session` decorator.
+
+    Use this decorator instead of ``@nox.session``. Session functions are passed
+    :class:`Session` instead of :class:`nox.sessions.Session`; otherwise, the
+    decorators work exactly the same.
+
+    Args:
+        args: Positional arguments are forwarded to ``nox.session``.
+        kwargs: Keyword arguments are forwarded to ``nox.session``.
+
+    Returns:
+        The decorated session function.
+    """
+    if not args:
+        return functools.partial(
+            session,
+            python=python,
+            reuse_venv=reuse_venv,
+            name=name,
+            venv_backend=venv_backend,
+            venv_params=venv_params,
+            tags=tags,
+            default=default,
+            requires=requires,
+            uv_groups=uv_groups,
+            uv_extras=uv_extras,
+            uv_all_extras=uv_all_extras,
+            uv_all_groups=uv_all_groups,
+        )  # type: ignore
+
+    [function] = args
+
+    is_uv = venv_backend == "uv"
+
+    # Create the `uv sync` command
+    sync_cmd = ["uv", "sync", "--no-default-groups"]
+
+    # Add the groups
+    for g in uv_groups:
+        sync_cmd.append(f"--group={g}")
+
+    # Add the extras
+    for e in uv_extras:
+        sync_cmd.append(f"--extra={e}")
+
+    if uv_all_groups:
+        sync_cmd.append("--all-groups")
+
+    if uv_all_extras:
+        sync_cmd.append("--all-extras")
+
+    @functools.wraps(function)
+    def wrapper(s: nox.Session, *_args: Any, **_kwargs: Any) -> None:
+        if is_uv:
+            env: dict[str, Any] = {"UV_PROJECT_ENVIRONMENT": s.virtualenv.location}
+
+            # UV called from Nox does not respect the Python version set in the Nox session.
+            # We need to pass the Python version to UV explicitly.
+            if s.python is not None:
+                env["UV_PYTHON"] = s.python
+
+            s.run_install(
+                *sync_cmd,
+                env=env,
+            )
+        function(nox.Session(s._runner), *_args, **_kwargs)
+
+    return nox.session(  # type: ignore
+        wrapper,
+        python=python,
+        reuse_venv=reuse_venv,
+        name=name,
+        venv_backend=venv_backend,
+        venv_params=venv_params,
+        tags=tags,
+        default=default,
+        requires=requires,
+    )

nox_uv-0.1.0/tests/test_lib.py

@@ -0,0 +1,2 @@
+def test_1() -> None:
+    assert 5 == 5