invoke-tasklib

Reusable Invoke tasks shared across Python projects.

Installation

Add invoke-tasklib as a dev dependency.

Usage

In your project's tasks.py:

from invoke_tasklib import ns

Set the required config in invoke.yaml at the project root:

tasklib:
  package:
    name: my_package

Then list the available tasks:

invoke --list

Tasks

Tasks are organized into namespaces: format.*, lint.*, types.*, test.*, env.*, release.*, doc.*.

format.* and lint.*

Tasks that check or verify something (never modify files, exit non-zero on violations) are named check_<target>. Tasks that modify files in place are named fix_<target>. Both share the same <target> (e.g. python, shell, docstrings) so the read-only/mutating counterpart of a task is easy to find:

When adding a new task to these namespaces, follow this convention: pick check_ or fix_ based on whether the task mutates files, and use a <target> name that matches its read-only/mutating counterpart if one exists.

types.*

test.*

env.*

release.*

doc.*

Config

Only tasklib.package.name is required. Everything else has a default derived from it. Full schema:

tasklib:
  package:
    name: my_package # required
    python_version: "3.14" # used by env.create-venv
  paths:
    src: src/my_package # default: src/<package.name>
    tests: tests
    unit_tests: tests/unit # default: <tests>/unit
    integration_tests: tests/integration # default: <tests>/integration
    functional_tests: tests/functional # default: <tests>/functional
    benchmarks: tests/benchmarks # default: <tests>/benchmarks
    docs_config: docs/mkdocs.yml

Composing a custom subset of tasks

If a project needs a different set of tasks, or a one-off task alongside the shared ones, import individual task modules instead of the pre-built ns:

from invoke import Collection
from invoke_tasklib import lint, test

from . import my_custom_task

ns = Collection(lint, test, my_custom_task)

Prefer adding a config knob to a shared task over forking it; reserve custom composition for things that are genuinely one-off to a single project.