Skip to main content

A task runner with typed commands, nested groups, and instant shell completion.

Project description

footman

A task runner with the soul of duty and the UX of typer: typed function signatures become real flags and positionals, modules become nested command groups, independent tasks run in parallel by default, and shell completion answers from a cached manifest in ~25 ms — without importing your code.

Ships two console scripts, footman and the two-letter fm. Zero runtime dependencies. Python 3.11+.

[!NOTE] Beta. footman is pre-1.0: the surface is settling, but minor versions may still include breaking changes — always called out in the changelog, never in a patch release. Pin the minor (footman~=0.15.0) if you build on it. The written stability promise lands with 1.0 — the road there is in ROADMAP.md.

Why

duty gets a lot right — the run() capture model, the decorator ergonomics — and footman keeps those ideas. Where it pushes is the parts that compound: completion served from a cache instead of re-importing your project on every TAB (~15× faster, measured), eager type and choice validation with errors that teach, a DAG scheduler that runs independent tasks concurrently (the same four-step check lands ~4× sooner than duty or invoke, measured), a monorepo task cascade that merges a tasks.py per folder, and a first-party story for testing your tasks. The receipts live in the comparison — every number reproducible from comparison/.

Taste

uv add --dev footman        # or: pip install footman
# tasks.py
from footman import task, group, run, tools

@task
def lint(fix: bool = False):
    "Run ruff over the project."
    tools.ruff.check("src", fix=fix)

@task(pre=[lint])
def test(*pytest_args):
    "Run the test suite (extra args after --)."
    tools.pytest(*pytest_args)

docs = group("docs", help="Documentation")

@docs.task(infinite=True)
def serve(port: int = 8000):
    "Serve the docs locally."
    run(f"mkdocs serve -a localhost:{port}")
$ fm lint --fix
$ fm lint test docs serve --port 8001   # one chain; independent tasks run in parallel
$ fm test -- -k grammar -x              # everything after -- goes to pytest
$ fm deploy produ
fm: deploy: <target> must be one of dev|staging|prod (got 'produ') — did you mean 'prod'?
$ fm --install-completion               # detects your shell; TAB answers in ~25 ms

Learn more

Documentation — start with Getting started, then the good parts: typed signatures · chaining & parallelism · monorepos · composing tasks · running tools · testing your tasks · completion · CI & automation · comparison with duty / invoke / poe / typer

MIT licensed. The road to 1.0 lives in ROADMAP.md.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

footman-0.15.0.tar.gz (114.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

footman-0.15.0-py3-none-any.whl (130.6 kB view details)

Uploaded Python 3

File details

Details for the file footman-0.15.0.tar.gz.

File metadata

  • Download URL: footman-0.15.0.tar.gz
  • Upload date:
  • Size: 114.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for footman-0.15.0.tar.gz
Algorithm Hash digest
SHA256 c39501da96835de5188972acb0c2fb0e0334758b2ffe6139d364ac4ee0bfd3d5
MD5 7120fee2817d6b8f033a8455e7bd30e0
BLAKE2b-256 518c8247bf7872fec5d7a47515edbd7774c65e5b06a1db7633ac7f177f876964

See more details on using hashes here.

Provenance

The following attestation bundles were made for footman-0.15.0.tar.gz:

Publisher: release.yml on willemkokke/footman

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file footman-0.15.0-py3-none-any.whl.

File metadata

  • Download URL: footman-0.15.0-py3-none-any.whl
  • Upload date:
  • Size: 130.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for footman-0.15.0-py3-none-any.whl
Algorithm Hash digest
SHA256 7adae3e644686fdb179dcb3dfbd6773b1629f4ed0a01be65fd177d4e1013ba75
MD5 44623f8756cbffc20656df907b534d96
BLAKE2b-256 d3071668620be314a4548a7dfb6f19db88cab6252aefe09369f0f81020f95574

See more details on using hashes here.

Provenance

The following attestation bundles were made for footman-0.15.0-py3-none-any.whl:

Publisher: release.yml on willemkokke/footman

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page