Skip to main content

Super lightweight task tracker that integrates directly with Git repositories.

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.2.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.2-py3-none-any.whl (13.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: kantrack-0.1.2.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.2.tar.gz
Algorithm Hash digest
SHA256 c1d0f4b49fc30d3e9f93e76e8cf153e0272b26185cd9031095b3c531d438e99d
MD5 7a4b011029e21e9b297c39f8fe222518
BLAKE2b-256 f5af02f43a6f2cca847499320c79209a01e605292a37d9b11bafe44cb27a5e92

See more details on using hashes here.

File details

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

File metadata

  • Download URL: kantrack-0.1.2-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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 ba7a320f122be4277ae567013376c102279df4fb08b2734a4710b7a077159d48
MD5 3638e5af7d53fe8acd119b85e1d678e8
BLAKE2b-256 5e12ac248b16d1c0a1a9121907a5686c1f000c803c070c4c25875e7e4c326779

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