Skip to main content

A Python-native task runner with content-hash caching and DAG execution.

Project description

ntask

PyPI PyPI - Python Version PyPI - License Build

A Python-native task runner with content-hash caching and DAG execution.

pip install ntask

Why

Your Makefile runs everything every time. Your Justfile has no dependency graph. Your tasks.py for Invoke is five years old, has no types, and you still have to write ctx.run. This is what a task runner looks like when you start over with caching, types, and a DAG.

Quickstart

A complete release pipeline in 20 lines. Drop this into tasks.py at your project root:

from ntask import task, cached, shell

@task
@cached(inputs=["src/**/*.py"])
def lint():
    shell("ruff check src/")

@task
@cached(inputs=["src/**/*.py"])
def typecheck():
    shell("mypy src/")

@task
@cached(inputs=["src/**/*.py", "tests/**/*.py"])
def test(pattern: str = ""):
    shell(f"pytest -q {'-k ' + pattern if pattern else ''}")

@task
@cached(inputs=["src/**/*.py", "pyproject.toml"], outputs=["dist/"])
def build():
    shell("python -m build")

@task(deps=[lint, typecheck, test, build])
def release(version: str):
    """Run checks, build, tag, and publish to PyPI."""
    shell(f"git tag v{version} && git push --tags && twine upload dist/*")

The first time you cut a release, every step runs:

$ ntask release --version=1.0.0 -j
running lint
running typecheck
running test
+ lint       (1.4s)
+ typecheck  (3.2s)
+ test       (4.9s)
running build
+ build      (2.3s)
running release
+ release    (0.9s)

The second time, ntask hashes the inputs, sees nothing changed, and skips every cached task. The whole dist/ directory is restored from the content-addressed store without re-running build:

$ ntask release --version=1.0.1 -j
o lint       cached (3a8f9c2d)
o typecheck  cached (b7c5f1e9)
o test       cached (9f2e8b14)
o build      cached (4dab8273)   <- dist/ restored, build did not run
running release
+ release    (0.9s)

Edit one file in src/ and only the tasks whose inputs match that file rerun. release isn't cached so it always runs, but everything downstream of an unchanged input stays a hit. That's transitive content-hash caching in five decorators.

Other things you'll reach for:

ntask --list                       # show every registered task with docstring
ntask test --pattern=auth          # type hints become CLI flags automatically
ntask --why test                   # explain the last cache decision item-by-item
ntask --graph release              # ASCII DAG (mermaid / dot also available)
ntask watch test                   # rerun on every src/ or tests/ change

Mermaid graph for docs

--graph-format mermaid emits a Mermaid block you can paste directly into a README or design doc. The example below is ntask's own DAG, captured straight from ntask --graph --graph-format mermaid:

graph TD
    install
    lint
    typecheck
    test
    check
    build
    release
    lint --> check
    typecheck --> check
    test --> check
    check --> release
    build --> release

--graph-format dot produces Graphviz output for the same data.

Team cache

Share cache hits across machines via S3 (or GCS, HTTP, NFS):

# pyproject.toml
[tool.ntask.remote_cache]
type = "s3"
bucket = "my-team-cache"
pip install ntask[s3]
ntask check                        # first person populates, the rest hit instantly
ntask check --offline              # skip the remote for fast dev loops

S3-compatibles (MinIO, R2, B2) take an endpoint_url. GCS and HTTP backends work the same way; the HTTP backend is plain GET/PUT/HEAD over stdlib urllib, so any object store with PUT enabled is fair game.

When NOT to use @cached

@cached shines on deterministic, input-driven work — lint, typecheck, test, build. It's the wrong fit when the task is the world reacting. Skip it (or be very deliberate about inputs= and env=) when the task:

  • has external side effects — DB writes, HTTP requests, sending email, queue pushes. A cache hit means none of that happened on this run.
  • mutates shared state your other tasks read — caches, file ownership, the contents of .env, dotted-out feature flags, the kernel's TCP backlog.
  • depends on the clock or on randomness — anything where the same inputs produce different output tomorrow.
  • exists to test the world — smoke tasks, integration probes, "does prod still look healthy" scenarios. The whole point is to re-execute.

For these, plain @task is the right call. Reach for parallel=False if the task must run alone (releases, migrations); reach for @group(...) to namespace them; don't reach for @cached.

Live DAG display

Run ntask check from an interactive terminal and a Textual TUI shows a live tree of the DAG with per-task state icons and durations. Pipe the output, set tui = false in [tool.ntask], or pass --no-tui to fall back to the line-based renderer.

Other things you'll reach for

  • Exclusive tasks. @task(parallel=False) makes a task a DAG-wide barrier: it waits for everything in flight to drain, then runs alone. Use it for releases, migrations, anything that mutates shared state.
  • Monorepos. @group("api") over a class namespaces every task method as api.<name>. Cross-group dependencies via @task(deps=[Other.task, ...]) or string fqns.
  • Capture output. shell("git rev-parse HEAD", capture=True) returns a ShellResult with .stdout, .stderr, .returncode, .duration, .ok.
  • Force a rerun. ntask --force <task> bypasses the cache for that one task. ntask --no-cache ignores the cache entirely. ntask clean wipes entry manifests; ntask clean --all wipes the whole .ntask/ directory.

Examples

Six runnable, self-contained examples under examples/:

File Demonstrates
01-hello Smallest possible cached task
02-python-lib install / lint / typecheck / test / build
03-parallel -j N fan-out and parallel=False barrier
04-watch ntask watch rerun-on-change loop
05-remote-cache local-fs remote backend shared between clones
06-monorepo @group(...) namespacing and cross-group deps

cd into any directory and run ntask --list.

Features

feature ntask make just invoke doit poe
Typed Python tasks yes no no partial no partial
Content-hash input caching yes partial no no partial no
Transitive cache-key propagation yes no no no partial no
Remote cache (S3/GCS/HTTP) yes no no no no no
DAG dependency resolution yes yes no partial yes no
Type-hint to CLI args yes no partial partial no yes
Parallel DAG execution (-j) yes yes no no yes no
Live DAG TUI yes no no no no no
Windows first-class yes partial yes yes yes yes

Cache miss messages name the specific file or env change that caused the invalidation. ntask --why <task> prints the full breakdown.

Docs

Requirements: Python 3.11 or newer. BSD-3-Clause.

License

BSD-3-Clause. Copyright © 2026 Sean Nieuwoudt.

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

ntask-1.1.3.tar.gz (78.4 kB view details)

Uploaded Source

Built Distribution

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

ntask-1.1.3-py3-none-any.whl (63.3 kB view details)

Uploaded Python 3

File details

Details for the file ntask-1.1.3.tar.gz.

File metadata

  • Download URL: ntask-1.1.3.tar.gz
  • Upload date:
  • Size: 78.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for ntask-1.1.3.tar.gz
Algorithm Hash digest
SHA256 a744e6a4dc96a7493ffc40ddb5577dafa54b6084aa77c60a657f8a87d6fc8417
MD5 1e784c2446e0393b3eb90bb8964330e3
BLAKE2b-256 fd2125e3e3cb6f1cd5f61668f037d53ae486ccb4345a2e481a6e14bdf86d293f

See more details on using hashes here.

File details

Details for the file ntask-1.1.3-py3-none-any.whl.

File metadata

  • Download URL: ntask-1.1.3-py3-none-any.whl
  • Upload date:
  • Size: 63.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for ntask-1.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 23521139da3fb30b2dd54da3902b1fdcd8f9bf5ab03a66197e35950028341aec
MD5 dca9ce71731eb745acfae41704c0771d
BLAKE2b-256 da176ad9cea3567bfcb6823dbb628e3d68f508b623417531a698749c1dfa8264

See more details on using hashes here.

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