Skip to main content

Super lightweight task tracker that integrates directly with Git repositories.

Project description

kantrack

PyPI Python Downloads 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.4.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.4-py3-none-any.whl (13.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: kantrack-0.1.4.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.4.tar.gz
Algorithm Hash digest
SHA256 67a7ba8b1a6d6c5d497f81c06d5955f03af3e48606ae5602123dbc4b655f55f2
MD5 d0019ce480d6c3458a8fac9ca1e77d79
BLAKE2b-256 9b58f44462557b406426eb66279cf325a7caac82220c4e3a591b0193270cfda7

See more details on using hashes here.

File details

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

File metadata

  • Download URL: kantrack-0.1.4-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.4-py3-none-any.whl
Algorithm Hash digest
SHA256 bb7e7eef80d51609cdb707452da68efc7e5c01c930d79b709c75b7d873473dc8
MD5 e8ed00d515cbc1cf8282c6be03a72d2f
BLAKE2b-256 3abb56a560b43210c4d795c3c2e0759058532cdc61d85b2e7fc5fe53de90e8b2

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