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.3.tar.gz (12.6 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.3-py3-none-any.whl (13.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: kantrack-0.1.3.tar.gz
  • Upload date:
  • Size: 12.6 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.3.tar.gz
Algorithm Hash digest
SHA256 82b827cbbeaf3647392b38ade2c44bc52af7cc702dee26009e1907e03b77bb24
MD5 dbea8b1c4ca90260653b2f069ed7530c
BLAKE2b-256 e22c4e986308dc6c6915454c2105b6b3cec240700b403fdf17c7d7ae1a747c2d

See more details on using hashes here.

File details

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

File metadata

  • Download URL: kantrack-0.1.3-py3-none-any.whl
  • Upload date:
  • Size: 13.3 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.3-py3-none-any.whl
Algorithm Hash digest
SHA256 67ffc8985e8f138abba0564ded6e3c506ba00153d9e04f15b5e6846cff31d678
MD5 4ae6fd7758b81f2609ea04bbd5809560
BLAKE2b-256 26665c1a44eb4fce110f6d56b28f39a3d836b8c00536e6425611b01329e6b928

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