Skip to main content

Kantrack is a lightweight Kanban task tracker that integrates directly with Git repositories, keeping project tasks versioned alongside your code. It features a simple FastAPI backend, a minimal web UI, and an intuitive CLI for managing tasks.

Project description

kantrack

Kantrack is a lightweight task tracker that lives in your Git repositories, keeping project tasks versioned alongside your code. It features a simple FastAPI backend, a minimal web UI, and a CLI for managing tasks. Kantrack is intended for solo developers who want an easy way to track their projects, keeping the task tracking as close to the code as possible - no need to sign in to 3rd party software, nothing to pay, and no risk of forgetting where all of your plans and notes are when you return to a project after six months.

Features

  • Git-native – Task data is stored in a json file inside your repository.
  • Minimal and fast – A FastAPI backend with a simple web interface.
  • CLI-first – Manage tasks efficiently with a command-line interface.

Installation

Install with pip:

pip install kantrack

Or with poetry:

poetry add kantrack

Usage

Start the Board

Start the board and open the web UI:

kantrack start

Runs a FastAPI server on 127.0.0.1:8000. You can specify the host and port, but you'd need to manually update the front-end code to point at the new host/port if you do so.

Add a Task (CLI)

Add a task to the default column ("planned")

kantrack add "Implement authentication"

Specify the column with --to "name", and the size with --size "size". If you specify a column name that doesn't exist, you'll be asked if you'd like to create it.

List Tasks (CLI)

kantrack list

Move a Task Between Columns (CLI)

kantrack mv "task name" --to "new column"

Remove a Task

kantrack rm "task name"

Development

Clone and install dependencies:

git clone https://github.com/YOUR_GITHUB_USERNAME/kantrack.git
cd kantrack
poetry install

Set up pre-commit hooks:

pre-commit install
pre-commit run --all-files

This ensures that code is formatted with Black and imports are managed with isort.

Contributing

Bug reports, feature requests, and contributions are welcome. Open an issue or submit a pull request on GitHub.

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

kantrack-0.1.0.tar.gz (12.5 kB view details)

Uploaded Source

Built Distribution

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

kantrack-0.1.0-py3-none-any.whl (13.2 kB view details)

Uploaded Python 3

File details

Details for the file kantrack-0.1.0.tar.gz.

File metadata

  • Download URL: kantrack-0.1.0.tar.gz
  • Upload date:
  • Size: 12.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.12.7 Darwin/23.3.0

File hashes

Hashes for kantrack-0.1.0.tar.gz
Algorithm Hash digest
SHA256 c1695f4cc239bc25f823ed6a2af773b73cb5d8658272329373f6918df53f0ac1
MD5 fb13ec5d888e4bec639b476f134e57f3
BLAKE2b-256 e72275cf2ecba5f7440f6a170189187e85f569c47743e652c2fe124ecdb454fb

See more details on using hashes here.

File details

Details for the file kantrack-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: kantrack-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 13.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.12.7 Darwin/23.3.0

File hashes

Hashes for kantrack-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f15c6ec2665b382aa996963affd8c212fe82cb8c9d5d35ef9e8b68e10f856b7b
MD5 b02bd8e479420ce8ca771f3e4064afc5
BLAKE2b-256 24c1cde59ac88df120e96dad1f01af062b8019ac4125f5853dd2bf76d0666bc3

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