Skip to main content

Lightweight task/issue tracking tool with JSON Lines storage

Project description

Ticketlog

Lightweight task/issue tracking tool

No daemon, no database - all operations done in-memory, then persisted into a JSON Lines storage.

Why?

This is heavily inspired by beads.

I tried beads, found it a bit too much for my needs and with weird failure modes. So I decided to make my own version of it, using the JSON Lines as a log file storing everything.

Installation

pip install ticketlog

This installs the tl command.

Alternatively, if you use uv:

uv tool install ticketlog

Features

  • Condensed Output: Clean, readable list format without heavy dependencies
  • Smart IDs: 3-letter alphanumeric IDs with configurable prefix
  • Deduplication: Built-in clean command to dedupe the log file
  • Dependency Tracking: Manage task dependencies and find ready-to-work tasks
  • JSON Support: All commands support --json flag for scripting
  • Import Support: Import tasks from beads JsonLines format

Usage

tl init    #  initialize a .ticketlog.toml config file

# or, use a custom prefix:
tl init --prefix myproj

The prefix is auto-generated from the project directory name by default.

Create a task

tl create "Fix login bug" --type bug --priority 0
tl create "Add user profile" --type feature --priority 2 --assignee alice
tl create "Write docs" --type chore --labels "documentation,help-wanted"

List tasks

# Default: show open, in_progress and to_review tasks
tl list   # or use the alias: tl ls

# Show all tasks
tl list --all

# Filter by status
tl list --status closed

# Filter by type
tl list --type bug

# Filter by assignee
tl list --assignee alice

# Filter by label
tl list --label documentation

Show task details

tl show tl-ab1

Update a task

# Change status
tl update tl-a1b --status in_progress

# Update multiple fields
tl update tl-a1b --title "New title" --priority P1 --assignee bob

# Add/remove labels
tl update tl-a1b --add-label urgent --add-label frontend
tl update tl-a1b --remove-label old-label

# Add notes
tl update tl-a1b --notes "Working on this, needs API changes"

Close tasks

# Close single task
tl close tl-a1b

# Close multiple tasks
tl close tl-a1b tl-bca tl-zyx

Import from beads JsonLines

Import tasks from a beads-format JsonLines file:

tl import beads tasks.jsonl

Clean and deduplicate log

Remove duplicate entries from the ticketlog file:

tl clean

Show tasks ready to work on

Lists tasks with status=open and no unresolved dependencies, sorted by priority.

tl ready

Manage dependencies

# Add dependency (tl-fds depends on tl-zyx, i.e., tl-zyx blocks tl-fds)
tl dep add tl-fds tl-zyx

# Remove dependency
tl dep remove tl-fds tl-zyx

# List dependencies for a task
tl dep list tl-fds

JSON output

All commands support --json flag for machine-readable output:

tl list --json | jq .
tl show tl-a1b --json
tl create "New task" --json

Data Model

Tasks are stored in ticketlog.jsonl (JSON Lines format) in the current directory.

Each task has:

  • id: Generated ID with configurable prefix and 3-letter alphanumeric code (e.g., tl-a1b, tl-xyz)
  • title: Task title
  • description: Detailed description
  • type: task, bug, feature, epic, or chore
  • status: open, in_progress, to_review, or closed
  • priority: 0-4 (0=highest/critical, 2=medium, 4=backlog)
  • assignee: Username or null
  • labels: List of label strings
  • created_at, updated_at, closed_at: ISO 8601 timestamps
  • dependencies: List of task IDs this task depends on
  • notes: Additional notes

Priority Levels

  • P0 (0): Critical - Highest priority
  • P1 (1): High priority
  • P2 (2): Medium priority (default)
  • P3 (3): Low priority
  • P4 (4): Backlog

Accept both formats: --priority 0 or --priority P0

Configuration

You can customize ticketlog behavior with a .ticketlog.toml configuration file in your project directory. Use tl init to create one automatically, or create it manually:

[project]
# Prefix for ticket IDs
# New tickets will have format: {prefix}-{3-letter-random-id}
prefix = "myproj"

This allows you to customize the prefix used in ticket IDs (e.g., change from tl-a1b to myproj-abc).

The configuration file can be placed at:

  • Your git repository root (automatically detected)
  • Any parent directory (walks up the tree to find config)
  • The current directory

File Format

Tasks are stored in append-only JSON Lines format:

  • One JSON object per line
  • Updates append new versions
  • Latest version is used when loading
  • No compaction needed for normal use

Examples

# Initialize project with custom prefix
tl init --prefix api

# Create project tasks
tl create "Design API" --type feature --priority 1
tl create "Implement API" --type feature --priority 1
tl create "Write tests" --type task --priority 2
tl create "Deploy to staging" --type task --priority 2

# Set up dependencies
tl dep add api-bca api-a1b  # Implementation depends on design
tl dep add api-zyx api-bca  # Tests depend on implementation
tl dep add api-fds api-zyx  # Deploy depends on tests

# Check what's ready to work on
tl ready  # Shows api-a1b (Design API)

# Start working on it
tl update api-a1b --status in_progress --assignee alice

# Complete it
tl close api-a1b

# Check again
tl ready  # Now shows api-bca (Implement API)

Development

Project structure:

ticketlog/
├── pyproject.toml
├── README.md
└── src/
    └── ticketlog/
        ├── __init__.py
        ├── __main__.py
        ├── cli.py          # CLI argument parsing
        ├── config.py       # Configuration management
        ├── models.py       # Task data model
        ├── storage.py      # JSON Lines storage
        ├── utils.py        # Formatting helpers
        └── commands/       # Command implementations
            ├── init.py
            ├── create.py
            ├── list.py
            ├── show.py
            ├── update.py
            ├── close.py
            ├── ready.py
            ├── start.py
            ├── dep.py
            ├── import_beads.py
            └── clean.py

License

MIT

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

ticketlog-0.3.0.tar.gz (15.8 kB view details)

Uploaded Source

Built Distribution

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

ticketlog-0.3.0-py3-none-any.whl (23.6 kB view details)

Uploaded Python 3

File details

Details for the file ticketlog-0.3.0.tar.gz.

File metadata

  • Download URL: ticketlog-0.3.0.tar.gz
  • Upload date:
  • Size: 15.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for ticketlog-0.3.0.tar.gz
Algorithm Hash digest
SHA256 68e78ae60c2c01a714efd9bc861549e5096cf5f4aec6e6bb730f7df5120d499e
MD5 d23eaaa4c0f2844131c6baf5f67cb653
BLAKE2b-256 7bc9feaf2406147044e3f679503a1dfe83ea85f14f3732837d25c1ff83d26887

See more details on using hashes here.

Provenance

The following attestation bundles were made for ticketlog-0.3.0.tar.gz:

Publisher: publish.yml on eliasdorneles/ticketlog

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file ticketlog-0.3.0-py3-none-any.whl.

File metadata

  • Download URL: ticketlog-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 23.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for ticketlog-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 320143693df5fafbf44025611ea124ea653942f52e17ee383c6698e90d6c28da
MD5 112ae22fbbc77874c375a4e2ac113d64
BLAKE2b-256 f8aefc60222ae97339a5d73905b409cdf5d2b06b8e63361aab316319154be000

See more details on using hashes here.

Provenance

The following attestation bundles were made for ticketlog-0.3.0-py3-none-any.whl:

Publisher: publish.yml on eliasdorneles/ticketlog

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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