Skip to main content

A local, file-backed productivity app for program/task tracking.

Project description

Taskwright

A local-first, file-backed productivity web app for managing tasks. Everything lives in plain files on your disk — no database, no account, no cloud. Point Taskwright at a folder and it serves a browser UI for dashboards, a Gantt timeline, a Kanban board, a calendar, notes, attachments, and an editable task side panel.

Documentation: a full guide is in the docs/ folder and is set up to build on Read the Docs (Sphinx + Markdown).

Why Taskwright

  • File-backed source of truth. Each task is a single JSON file you can read, diff, and commit to git. The whole workspace is a folder you own.
  • Local-first. Runs entirely on 127.0.0.1. Your data never leaves your machine.
  • Git-aware. The UI shows branch/ahead/behind/dirty status and has a one-click commit + pull + push sync button when the workspace folder itself is a git repo.

Workspace layout

The source of truth is a workspace folder:

workspace/
  config.json           # editable workspace/app metadata
  projects/
    apollo.json         # one file per project
  tasks/
    A1B2-C3D4-E5F6-7890.json  # one file per task (native id format)
  milestones/
    M-1A2B-3C4D.json    # one file per milestone (groups tasks across projects)
  assets/
    A1B2-C3D4-E5F6-7890/  # attachments live alongside their task id
      screenshot.png

The app provides a browser UI for viewing dashboards, timelines, task boards, notes, attachments, and editing tasks through a side panel.

Install locally

From a clone of this repository:

pip install -e .

This installs the taskwright command. (A PyPI release will come later; for now install from source.)

Quick start

taskwright serve --workspace ./my-workboard

If the workspace folder does not exist yet, taskwright serve will create the empty Taskwright structure for you. You can also run it from the current directory and let Taskwright use . as the workspace.

Then open:

http://127.0.0.1:8000

init is available if you want to scaffold a folder explicitly. It creates an editable config.json, empty projects/, tasks/, milestones/, and assets/ directories, plus a README stub. It does not create starter projects or tasks; use the app to add your own once you begin.

Serve an existing workspace

taskwright serve --workspace ./path/to/workspace --host 127.0.0.1 --port 8000
Flag Default Description
--workspace . Workspace folder to serve
--host 127.0.0.1 Host interface to bind
--port 8000 Port to listen on
--reload off Enable uvicorn auto-reload (development)

Task file example

{
  "id": "A1B2-C3D4-E5F6-7890",
  "title": "CAF refinement prototype",
  "status": "working",
  "priority": "high",
  "project": "Apollo",
  "summary": "Build a prototype CAF refinement workflow.",
  "description": "Compare baseline CAF sharpness against protection-aware refinement.",
  "tags": ["caf", "signal-processing", "prototype"],
  "start_date": "2026-06-24",
  "due_date": "2026-06-30",
  "completed_date": null,
  "percent_complete": 60,
  "depends_on": ["0EBB-528F-371E-61AE"],
  "checklist": [
    {"text": "Generate baseline CAF", "done": true},
    {"text": "Export comparison plots", "done": false}
  ],
  "notes": [
    {
      "created_at": "2026-06-26T10:30:00",
      "body": "Protection-aware version improved sharpness."
    }
  ],
  "attachments": []
}

depends_on stores task ids. In the UI you add dependencies with a search-as-you-type picker that finds tasks by name and shows their status, project, due date, and id — then stores the id. Dependencies are reflected on the Gantt timeline (an ↳ after <name> label plus a marker where the dependency's bar ends).

Milestones

Milestones are a separate entity from projects. A milestone can span multiple projects, holds an ordered list of tasks (which can come from any project, and a task can belong to any number of milestones), and has its own description, notes, and attachments — just like a task.

  • Open the Milestones view to see every milestone with a live rollup (task count, progress, target date).
  • Click a milestone to filter the whole board to just its tasks and show a rollup banner; the side panel opens the milestone for editing.
  • Each milestone has its own colour used on milestone cards and the rollup banner.
  • From inside a milestone you can add a task with one search-as-you-type picker and use the sticky + New task button at the bottom of the list for quick creation (auto-added to that milestone), and remove tasks.

Milestones are stored one JSON file per milestone under milestones/.

Features

  • JSON-per-task source model you can version with git
  • Dashboard summary cards (total / done / working / blocked)
  • Kanban-style board with per-project color strips
  • Gantt timeline with dependency markers
  • Calendar view
  • Milestones that group tasks across projects, with per-milestone colour, click-to-filter rollup, and their own notes/attachments/description
  • Click any task (row, card, timeline bar, calendar entry) to open an editable side panel
  • Save edits back to the JSON file; raw JSON editor escape hatch
  • Notes list and attachment/image uploads
  • Searchable "depends on" picker that resolves names to task ids
  • Project management with custom colors, each stored in its own JSON file
  • Filtering by project, milestone, date range, and free-text search; sortable views
  • CSV / JSON export
  • Built-in git status chip and one-click sync (commit + pull + push)

Building the docs locally

pip install -e ".[docs]"
sphinx-build -b html docs docs/_build/html

Open docs/_build/html/index.html. On Read the Docs the build is driven by .readthedocs.yaml.

Development

pip install -e ".[dev]"
pytest
ruff check .

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

taskwright-2026.3.tar.gz (43.2 kB view details)

Uploaded Source

Built Distribution

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

taskwright-2026.3-py3-none-any.whl (46.2 kB view details)

Uploaded Python 3

File details

Details for the file taskwright-2026.3.tar.gz.

File metadata

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

File hashes

Hashes for taskwright-2026.3.tar.gz
Algorithm Hash digest
SHA256 63b14641bfcb3fbb3c08b22340ec8fccd3ee6fbe9ceab906f36e84f143d5855d
MD5 a9d1b2ba406ccf4301d2625d267fbc5b
BLAKE2b-256 e5668c9d96e26dcb4a123974b5cb0a466632d51d7765cd1a6c686cc4dba8890d

See more details on using hashes here.

File details

Details for the file taskwright-2026.3-py3-none-any.whl.

File metadata

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

File hashes

Hashes for taskwright-2026.3-py3-none-any.whl
Algorithm Hash digest
SHA256 cc4581318677add1059527c6bbfa1935244e6e6342eaf39d04813d19608add93
MD5 78851d850cfc443d0212ca8def1599ee
BLAKE2b-256 d3904df0f0eceb67a0f28cf99073fbe8a264750cb8755b4b3a5cb4da2acc8a6d

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