Skip to main content

Generic tasks and kanban boards for the Stapel framework

Project description

stapel-tasks

CI codecov PyPI

Generic tasks and kanban boards for the Stapel framework — composable Django apps that deploy as a monolith or as microservices without changing module code.

A generic task domain — Board / Column / Task / ChecklistItem / TaskComment, a REST surface, a full outbox event surface, and custom fields via stapel-attributes. It is useful to any project by itself (a team runs a board by hand), and it is the substrate an orchestrator projects onto: an external state machine drives cards through opaque origin_* handles and the MOVE_POLICY seam — the module knows nothing about the machine.

Install

pip install stapel-tasks              # core
pip install "stapel-tasks[attributes]"  # + typed custom-field validation
INSTALLED_APPS = [
    # ...
    "stapel_tasks",
]

# urls.py
path("tasks/", include("stapel_tasks.urls"))

Requires a stapel-core whose background taskstore app uses the label stapel_taskstore — this module owns the Django label stapel_tasks. See MODULE.md.

Concepts

  • Board — an ordered set of columns and the cards on them. Owns the custom-field schema (feature_defs) and optional workflow settings.
  • Column — a status. Its key is the card's status; its category (backlog/active/review/waiting/done) is the fixed machine semantic.
  • Task (card) — status = its column; order within the column is a fractional position (drag-and-drop moves write one row). Custom-field values live in features; a projecting system writes origin_meta.
  • Move — drag-and-drop is a move validated by MOVE_POLICY: allow / deny(reason_key) / defer (the managed-card path).
from stapel_tasks import services

board = services.create_board(name="Team", preset="simple")
card = services.create_task(board=board, title="Ship it")
services.move_task(card, to_column=board.columns.get(key="done"))  # emits task.completed

comm surface

Kind Name Purpose
Emit task.created / task.updated / task.moved / task.assigned / task.completed / task.comment_added / task.checklist_item_changed / task.archived Card lifecycle facts (via the outbox)
Consume user.deleted GDPR anonymization
Function tasks.get / tasks.list_board / tasks.create / tasks.move / tasks.comment Machine interface / MCP-tool candidates

Settings (STAPEL_TASKS)

Key Default What it customizes
SCOPE_PROVIDER single global scope, allow-all Tenancy resolution/filtering + permissions
MOVE_POLICY allow any move (honours transitions) Drag-and-drop authorization
BOARD_PRESETS {} (merged over built-in simple) Board-shape presets
STORE_UNKNOWN_FEATURES True Keep raw custom fields when attributes is absent
DEFAULT_PAGE_SIZE 100 Card-list page size

See MODULE.md for the full seam map (providers, registries, serializer seams, comm tables, anti-patterns, override-vs-upstream).

License

MIT

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

stapel_tasks-0.1.3.tar.gz (45.2 kB view details)

Uploaded Source

Built Distribution

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

stapel_tasks-0.1.3-py3-none-any.whl (49.0 kB view details)

Uploaded Python 3

File details

Details for the file stapel_tasks-0.1.3.tar.gz.

File metadata

  • Download URL: stapel_tasks-0.1.3.tar.gz
  • Upload date:
  • Size: 45.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for stapel_tasks-0.1.3.tar.gz
Algorithm Hash digest
SHA256 72589ad562d50847d1e0e581dc03fc5e3c1549b6d55c9729353fd5fa515377e8
MD5 89f89941dc05a927df5229a30384c065
BLAKE2b-256 0374fcf0fa0b859f1d4191b612ddcf66bc5b5fc82cd067749ae7f4cdeb7be4ff

See more details on using hashes here.

Provenance

The following attestation bundles were made for stapel_tasks-0.1.3.tar.gz:

Publisher: publish.yml on usestapel/stapel-tasks

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

File details

Details for the file stapel_tasks-0.1.3-py3-none-any.whl.

File metadata

  • Download URL: stapel_tasks-0.1.3-py3-none-any.whl
  • Upload date:
  • Size: 49.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for stapel_tasks-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 78bc40246036d5a835df9519838e2c4da7a0b72477bc61e7b16f7b9f1f1dc686
MD5 bfbf19617491b16052af9c24dbe125d1
BLAKE2b-256 6e1f08b87b5db406deb2ac31dd1a8a62d0075d09209e7b5250a1685f0d58727b

See more details on using hashes here.

Provenance

The following attestation bundles were made for stapel_tasks-0.1.3-py3-none-any.whl:

Publisher: publish.yml on usestapel/stapel-tasks

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