Skip to main content

Super lightweight task tracker that integrates directly with Git repositories.

Project description

kantrack

PyPI Python License

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

Set where the board is written. By default, it writes to kantrack_data.json in the git root, or the current working directory if the folder isn't a git repo. You can control the write location by setting the KANTRACK_WRITE_DIR environment variable:

export KANTRACK_WRITE_DIR="board"

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.5.tar.gz (13.0 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.5-py3-none-any.whl (13.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: kantrack-0.1.5.tar.gz
  • Upload date:
  • Size: 13.0 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.5.tar.gz
Algorithm Hash digest
SHA256 4d90333ca86d1c6516742fd4f8d8b77870a30fd81130c18b8b482ad6ab710a83
MD5 4eec31bb204e2c0ca053702c3e42ff2d
BLAKE2b-256 beae006c1c81522b633c5174652374a911eb93b2b665d36eb0047a43930d7b18

See more details on using hashes here.

File details

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

File metadata

  • Download URL: kantrack-0.1.5-py3-none-any.whl
  • Upload date:
  • Size: 13.5 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.5-py3-none-any.whl
Algorithm Hash digest
SHA256 9ba775398462102f5ffe6c2b2c61af626a94fffdbb01854fc7725dee7965c732
MD5 0c80631ee1f20becbab8a50953d32fb5
BLAKE2b-256 f252f41d61aede2444f6a22baae16aadc3119e9660a84f39937b89b838423c3a

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