minchin.tasks 1.0.0__tar.gz

minchin_tasks-1.0.0/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 William Minchin
+
+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.

minchin_tasks-1.0.0/PKG-INFO

@@ -0,0 +1,46 @@
+Metadata-Version: 2.4
+Name: minchin.tasks
+Version: 1.0.0
+Summary: Common development tasks (lint, format, test, ...) for use with Invoke.
+Author-email: William Minchin <w_minchin@hotmail.com>
+License-Expression: MIT
+Project-URL: Bug Tracker, https://github.com/MinchinWeb/minchin.tasks/issues
+Project-URL: Repository, https://github.com/MinchinWeb/minchin.tasks
+Project-URL: Changelog, https://github.com/MinchinWeb/minchin.tasks/blob/master/CHANGELOG.rst
+Classifier: Development Status :: 4 - Beta
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Natural Language :: English
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Environment :: Console
+Requires-Python: >=3.9
+Description-Content-Type: text/x-rst
+License-File: LICENSE.txt
+Requires-Dist: invoke>=2.0.0
+Requires-Dist: taplo
+Requires-Dist: validate-pyproject
+Dynamic: license-file
+
+Minchin.Tasks
+=============
+
+Common development tasks for use with `Invoke <https://www.pyinvoke.org/>`_.
+Defaults to a ``uv`` and ``ruff`` setup, but should continue to work with
+``black``, ``isort``, and ``pip-tools``. Useful for applying my in-house Python
+style, see https://github.com/minchinweb/python-style-guide
+
+In your ``tasks.py`` (import each for clarity)::
+
+    from minchin.tasks import check, format_code, lint, test, update, upgrade  # noqa: F401
+
+The tasks are defined in ``minchin.tasks.dev``; ``minchin.tasks`` re-exports them.
+
+This gives you:
+
+- ``invoke update`` -- update requirements to the current versions
+- ``invoke upgrade`` -- install the locked requirements
+- ``invoke lint`` -- report only format check, including ``pyproject.toml``
+- ``invoke format`` -- fix formatting issues
+- ``invoke test`` -- run ``pytest``.
+- ``invoke check`` -- ``lint`` and ``test``.

minchin_tasks-1.0.0/README.rst

@@ -0,0 +1,22 @@
+Minchin.Tasks
+=============
+
+Common development tasks for use with `Invoke <https://www.pyinvoke.org/>`_.
+Defaults to a ``uv`` and ``ruff`` setup, but should continue to work with
+``black``, ``isort``, and ``pip-tools``. Useful for applying my in-house Python
+style, see https://github.com/minchinweb/python-style-guide
+
+In your ``tasks.py`` (import each for clarity)::
+
+    from minchin.tasks import check, format_code, lint, test, update, upgrade  # noqa: F401
+
+The tasks are defined in ``minchin.tasks.dev``; ``minchin.tasks`` re-exports them.
+
+This gives you:
+
+- ``invoke update`` -- update requirements to the current versions
+- ``invoke upgrade`` -- install the locked requirements
+- ``invoke lint`` -- report only format check, including ``pyproject.toml``
+- ``invoke format`` -- fix formatting issues
+- ``invoke test`` -- run ``pytest``.
+- ``invoke check`` -- ``lint`` and ``test``.

minchin_tasks-1.0.0/minchin/tasks/__init__.py

@@ -0,0 +1,24 @@
+"""Common development tasks to use from `invoke`.
+
+In a project's ``tasks.py``::
+
+    from minchin.tasks import (  # noqa: F401
+        check,
+        format_code,
+        lint,
+        test,
+        update,
+        upgrade,
+    )
+
+Uses ``uv run`` under the hood by default, or ``pip-tools`` on "legacy" setups.
+The tasks themselves live in `minchin.tasks.dev`.
+"""
+
+from __future__ import annotations
+
+from minchin.tasks.dev import check, format_code, lint, test, update, upgrade
+
+__version__ = "1.0.0"
+
+__all__ = ["check", "format_code", "lint", "test", "update", "upgrade"]

minchin_tasks-1.0.0/minchin/tasks/dev.py

@@ -0,0 +1,162 @@
+"""Common development tasks (lint, format, test, ...) to use from `invoke`.
+
+Uses ``uv run`` under the hood by default, or ``pip-tools`` on "legacy" setups.
+"""
+
+from __future__ import annotations
+
+import sys
+from pathlib import Path
+
+from invoke import task
+
+__all__ = ["check", "format_code", "lint", "test", "update", "upgrade"]
+
+
+def _uses_uv() -> bool:
+    # A `uv.lock` implies the project is managed by uv
+    return Path("uv.lock").is_file()
+
+
+def _pip_tools_inputs() -> list[Path]:
+    # look for `.in` files in both `.requirements/*.in` or the repo root `*.in`
+    found = [*Path(".requirements").glob("*.in"), *Path().glob("*.in")]
+    # blacklist `MANIFEST.in` as a setuptools file
+    return sorted(p for p in found if p.name.lower() != "manifest.in")
+
+
+def _compiled_requirements() -> dict[str, Path]:
+    """Get a list of the requirement files.
+
+    `requirements-base.in` is assumed to the "main" one.
+    """
+    found = {}
+    for path in _pip_tools_inputs():
+        compiled = path.with_suffix(".txt")
+        if not compiled.is_file():
+            continue
+        name = compiled.stem.removeprefix("requirements").lstrip("-_")
+        if name in ("", "base"):
+            name = "main"
+        found[name] = compiled
+    return found
+
+
+def _uses_black() -> bool:
+    # Black/isort config in `pyproject.toml` without a ruff config
+    pyproject = Path("pyproject.toml")
+    if not pyproject.is_file():
+        return False
+    text = pyproject.read_text(encoding="utf-8")
+    legacy = "[tool.black]" in text or "[tool.isort]" in text
+    return legacy and "[tool.ruff" not in text
+
+
+def _run_prefix() -> str:
+    # run uv projects using `uv`
+    return "uv run " if _uses_uv() else ""
+
+
+@task
+def update(ctx):
+    """Refresh the requirements with the current versions.
+
+    Rewrites `uv.lock`, or recompiles pip-tools' `.txt`.
+    """
+    if _uses_uv():
+        ctx.run("uv lock --upgrade", pty=False)
+        return
+    inputs = _pip_tools_inputs()
+    if not inputs:
+        raise SystemExit("No `uv.lock` or pip-tools `.in` files found.")
+    for source in inputs:
+        ctx.run(f"pip-compile --upgrade {source.as_posix()}", pty=False)
+
+
+@task(
+    iterable=["extra"],
+    help={
+        "extra": "Also install this requirements set, e.g. `dev` ("
+        "pip-tools projects only)",
+        "all_": "Install every compiled requirements file (pip-tools only)",
+        "dry_run": "Show what would change without installing anything",
+    },
+)
+def upgrade(ctx, extra=None, all_=False, dry_run=False):
+    """Install based on the current requiremnts.
+
+    Runs `uv sync`, or `pip-sync` on the main compiled pip-tools file plus any
+    sets named with `--extra` (or all of them with `--all`).
+
+    Use `--dry-run` to check first.
+    """
+    flag = " --dry-run" if dry_run else ""
+    if _uses_uv():
+        ctx.run(f"uv sync{flag}", pty=False)
+        return
+    available = _compiled_requirements()
+    if not available:
+        raise SystemExit("No `uv.lock` or compiled pip-tools `.txt` files found.")
+    names = list(available) if all_ else ["main", *(extra or [])]
+    unknown = [n for n in names if n not in available]
+    if unknown:
+        raise SystemExit(
+            f"No compiled requirements for: {', '.join(unknown)}. "
+            f"Available: {', '.join(available)}."
+        )
+    # pip-sync wants each file once; keep the order given
+    files = dict.fromkeys(available[n].as_posix() for n in names)
+    ctx.run(f"pip-sync{flag} {' '.join(files)}", pty=False)
+
+
+@task
+def lint(ctx):
+    """Check code, formatting and `pyproject.toml`."""
+    run = _run_prefix()
+    if _uses_black():
+        ctx.run(f"{run}black --check .", pty=False)
+        ctx.run(f"{run}isort --check-only .", pty=False)
+        print(
+            "WARNING: pyproject.toml was not checked (validate-pyproject and "
+            "taplo only run for ruff projects); review it by hand.",
+            file=sys.stderr,
+        )
+        return
+
+    ctx.run("uv run ruff check", pty=False)
+    ctx.run("uv run ruff format --check", pty=False)
+    ctx.run("uv run validate-pyproject pyproject.toml", pty=False)
+    ctx.run("uv run taplo format --check pyproject.toml", pty=False)
+
+
+# named `format_code` so it doesn't shadow the builtin (ruff rule `A`)
+@task(name="format")
+def format_code(ctx):
+    """Apply safe lint fixes, import sorting and formatting (code and TOML)."""
+    if _uses_black():
+        run = _run_prefix()
+        ctx.run(f"{run}isort .", pty=False)
+        ctx.run(f"{run}black .", pty=False)
+        return
+
+    # unfixable problems exit non-zero; still format, `lint` reports them
+    ctx.run("uv run ruff check --fix", pty=False, warn=True)
+    ctx.run("uv run ruff format", pty=False)
+    ctx.run("uv run taplo format pyproject.toml", pty=False)
+
+
+@task
+def test(ctx):
+    """Run the test suite.
+
+    Assumes `pytest`.
+    """
+    ctx.run(f"{_run_prefix()}pytest", pty=False)
+
+
+@task(pre=[lint, test])
+def check(ctx):
+    """lint, formatting and tests.
+
+    Useful for single-run CI runs.
+    """

minchin_tasks-1.0.0/minchin/tasks/tests/test_dev.py

@@ -0,0 +1,58 @@
+"""Tests for the shared development tasks."""
+
+from __future__ import annotations
+
+from invoke import Collection, Context
+
+from minchin.tasks import dev as tasks
+
+
+class RecordingContext(Context):
+    """Stands in for an Invoke context and records the commands it is given."""
+
+    def __init__(self):
+        super().__init__()
+        self.commands = []
+
+    def run(self, command, **kwargs):
+        self.commands.append((command, kwargs))
+
+
+def run_task(task):
+    ctx = RecordingContext()
+    task(ctx)
+    return ctx.commands
+
+
+def test_update_and_upgrade_mirror_apt():
+    assert run_task(tasks.update)[0][0] == "uv lock --upgrade"
+    assert run_task(tasks.upgrade)[0][0] == "uv sync"
+
+
+def test_lint_changes_nothing_and_checks_pyproject():
+    commands = [c for c, _ in run_task(tasks.lint)]
+    assert commands == [
+        "uv run ruff check",
+        "uv run ruff format --check",
+        "uv run validate-pyproject pyproject.toml",
+        "uv run taplo format --check pyproject.toml",
+    ]
+
+
+def test_format_still_formats_when_lint_fixes_fail():
+    commands = run_task(tasks.format_code)
+    assert commands[0][0] == "uv run ruff check --fix"
+    assert commands[0][1]["warn"] is True
+    assert [c for c, _ in commands[1:]] == [
+        "uv run ruff format",
+        "uv run taplo format pyproject.toml",
+    ]
+
+
+def test_task_names_match_the_documented_commands():
+    names = set(Collection.from_module(tasks).task_names)
+    assert names == {"check", "format", "lint", "test", "update", "upgrade"}
+
+
+def test_check_runs_lint_then_test():
+    assert [t.__name__ for t in tasks.check.pre] == ["lint", "test"]

minchin_tasks-1.0.0/minchin.tasks.egg-info/PKG-INFO

@@ -0,0 +1,46 @@
+Metadata-Version: 2.4
+Name: minchin.tasks
+Version: 1.0.0
+Summary: Common development tasks (lint, format, test, ...) for use with Invoke.
+Author-email: William Minchin <w_minchin@hotmail.com>
+License-Expression: MIT
+Project-URL: Bug Tracker, https://github.com/MinchinWeb/minchin.tasks/issues
+Project-URL: Repository, https://github.com/MinchinWeb/minchin.tasks
+Project-URL: Changelog, https://github.com/MinchinWeb/minchin.tasks/blob/master/CHANGELOG.rst
+Classifier: Development Status :: 4 - Beta
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Natural Language :: English
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Environment :: Console
+Requires-Python: >=3.9
+Description-Content-Type: text/x-rst
+License-File: LICENSE.txt
+Requires-Dist: invoke>=2.0.0
+Requires-Dist: taplo
+Requires-Dist: validate-pyproject
+Dynamic: license-file
+
+Minchin.Tasks
+=============
+
+Common development tasks for use with `Invoke <https://www.pyinvoke.org/>`_.
+Defaults to a ``uv`` and ``ruff`` setup, but should continue to work with
+``black``, ``isort``, and ``pip-tools``. Useful for applying my in-house Python
+style, see https://github.com/minchinweb/python-style-guide
+
+In your ``tasks.py`` (import each for clarity)::
+
+    from minchin.tasks import check, format_code, lint, test, update, upgrade  # noqa: F401
+
+The tasks are defined in ``minchin.tasks.dev``; ``minchin.tasks`` re-exports them.
+
+This gives you:
+
+- ``invoke update`` -- update requirements to the current versions
+- ``invoke upgrade`` -- install the locked requirements
+- ``invoke lint`` -- report only format check, including ``pyproject.toml``
+- ``invoke format`` -- fix formatting issues
+- ``invoke test`` -- run ``pytest``.
+- ``invoke check`` -- ``lint`` and ``test``.

minchin_tasks-1.0.0/minchin.tasks.egg-info/SOURCES.txt

@@ -0,0 +1,11 @@
+LICENSE.txt
+README.rst
+pyproject.toml
+minchin.tasks.egg-info/PKG-INFO
+minchin.tasks.egg-info/SOURCES.txt
+minchin.tasks.egg-info/dependency_links.txt
+minchin.tasks.egg-info/requires.txt
+minchin.tasks.egg-info/top_level.txt
+minchin/tasks/__init__.py
+minchin/tasks/dev.py
+minchin/tasks/tests/test_dev.py

minchin_tasks-1.0.0/minchin.tasks.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

minchin_tasks-1.0.0/minchin.tasks.egg-info/requires.txt

@@ -0,0 +1,3 @@
+invoke>=2.0.0
+taplo
+validate-pyproject

minchin_tasks-1.0.0/minchin.tasks.egg-info/top_level.txt

@@ -0,0 +1 @@
+minchin

minchin_tasks-1.0.0/pyproject.toml

@@ -0,0 +1,132 @@
+[build-system]
+# v77 needed for SPDX `license` expressions (PEP 639)
+requires = ["setuptools >= 77"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "minchin.tasks"
+description = "Common development tasks (lint, format, test, ...) for use with Invoke."
+dynamic = ["version", "readme"]
+authors = [{ name = "William Minchin", email = "w_minchin@hotmail.com" }]
+requires-python = ">= 3.9"
+license = "MIT"
+license-files = ["LICEN[CS]E*"]
+classifiers = [
+  # having an unknown classifier should keep PyPI from accepting the
+  # package as an upload
+  # 'Private :: Do Not Upload',
+  # 'Development Status :: 1 - Planning',
+  # 'Development Status :: 2 - Pre-Alpha',
+  # 'Development Status :: 3 - Alpha',
+  'Development Status :: 4 - Beta',
+  # 'Development Status :: 5 - Production/Stable',
+  # 'Development Status :: 6 - Mature',
+  # 'Development Status :: 7 - Inactive',
+  "Programming Language :: Python :: 3",
+  # "Programming Language :: Python :: 3.9",
+  # "Programming Language :: Python :: 3.10",
+  # "Programming Language :: Python :: 3.11",
+  # "Programming Language :: Python :: 3.12",
+  # "Programming Language :: Python :: 3.13",
+  # "Programming Language :: Python :: 3.14",
+  # "Programming Language :: Python :: 3.15",
+  "Programming Language :: Python :: 3 :: Only",
+  "Natural Language :: English",
+  "Intended Audience :: Developers",
+  "Operating System :: OS Independent",
+  "Environment :: Console",
+  # full list at https://pypi.org/classifiers/
+]
+dependencies = [
+  "invoke >= 2.0.0",
+  # for pyproject.toml format checks
+  "taplo",
+  "validate-pyproject",
+]
+
+[project.urls]
+"Bug Tracker" = "https://github.com/MinchinWeb/minchin.tasks/issues"
+Repository = "https://github.com/MinchinWeb/minchin.tasks"
+Changelog = "https://github.com/MinchinWeb/minchin.tasks/blob/master/CHANGELOG.rst"
+
+[dependency-groups]
+# PEP 735; not published. `uv sync` installs `dev` by default.
+dev = ["pytest >= 8", "ruff >= 0.14", { include-group = "release" }]
+release = ["minchin.releaser >= 0.9.6"]
+
+[tool.setuptools.packages.find]
+# flat layout; tests live in the package (`minchin/<name>/tests/`).
+# `minchin` is an implicit (PEP 420) namespace package, so it has NO
+# `__init__.py`
+include = ["minchin*"]
+exclude = [
+  # top-level only; `minchin.<name>.tests` ships with the package
+  "build",
+  "dist",
+  "docs",
+  "env",
+  "test",
+  "tests",
+]
+
+[tool.setuptools.dynamic]
+# this has to be the place the version is located via static analysis, i.e.
+# a plain `__version__ = "x.y.z"` with no imports needed to compute it
+version = { attr = "minchin.tasks.__version__" }
+readme = { file = ["README.rst"], content-type = "text/x-rst" }
+
+[tool.pytest.ini_options]
+addopts = ["--import-mode=importlib"]
+# tests ship inside the package: minchin/<name>/tests/
+testpaths = ["minchin"]
+
+[tool.ruff]
+line-length = 88
+# also skip excluded paths when a path is given explicitly
+force-exclude = true
+extend-exclude = ["_build"]
+
+[tool.ruff.format]
+# Reformat code snippets in docstrings.
+docstring-code-format = true
+# Keep each file's existing line endings, so Windows (CRLF working tree) and
+# the Linux CI runner don't fight each other.
+line-ending = "auto"
+
+[tool.ruff.lint]
+# Enable `from __future__ import annotations` imports
+future-annotations = true
+# Added to ruff's default (E4, E7, E9, F)
+extend-select = [
+  "A",   # shadowing builtin names
+  "B",   # bugbear
+  "E",
+  "W",   # pycodestyle
+  "I",   # isort
+  "N",   # PEP8 naming
+  "PTH", # use pathlib
+  "RUF", # ruff-specific
+  "SIM", # simplify
+  "UP",  # pyupgrade (limited by `requires-python`)
+  "YTT", # flake8-2020 (common issues with Python version checks)
+]
+
+[tool.ruff.lint.isort]
+# Sort imports within their section independent of the import type
+force-sort-within-sections = true
+known-first-party = ["minchin"]
+# Framework sections are standard boilerplate; an unused one costs nothing.
+# Delete a section's name from `section-order` only if its package clashes.
+section-order = [
+  "future",
+  "standard-library",
+  "django",
+  "pelican",
+  "third-party",
+  "first-party",
+  "local-folder",
+]
+
+[tool.ruff.lint.isort.sections]
+"django" = ["django"]
+"pelican" = ["pelican"]

minchin_tasks-1.0.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+