Skip to main content

A full-featured terminal user interface for hledger plain-text accounting

Project description

hledger-textual

PyPI GitHub Release

A full-featured terminal user interface for hledger plain-text accounting. Manage transactions, recurring rules, budgets, and investments — with multi-period reports, account drill-downs, and git sync — all from your terminal.

Built with Textual and Python.

hledger-textual demo

Stack

  • Python 3.12+
  • Textual - TUI framework
  • hledger - plain-text accounting (must be installed separately)
  • uv - package manager (no requirements.txt needed, dependencies are in pyproject.toml)
  • pytest - testing

Requirements

  • Python 3.12+
  • hledger installed and available in PATH

Installation

# With pipx
pipx install hledger-textual

# With uv
uv tool install hledger-textual

Usage

hledger-textual -f path/to/your.journal

The journal file is resolved in this order:

  1. -f / --file CLI argument
  2. LEDGER_FILE environment variable
  3. ~/.config/hledger-textual/config.toml (journal_file key)
  4. ~/.hledger.journal

Documentation

See the Wiki for the full documentation: feature overview, configuration, investment tracking, and per-tab reference.

Development

git clone https://github.com/thesmokinator/hledger-textual.git
cd hledger-textual
uv sync

Testing

# Run all tests
uv run pytest

# Run with verbose output
uv run pytest -v

# Run with coverage report
uv run pytest --cov=hledger_textual --cov-report=term-missing

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

hledger_textual-0.2.9.tar.gz (112.1 kB view details)

Uploaded Source

Built Distribution

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

hledger_textual-0.2.9-py3-none-any.whl (151.5 kB view details)

Uploaded Python 3

File details

Details for the file hledger_textual-0.2.9.tar.gz.

File metadata

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

File hashes

Hashes for hledger_textual-0.2.9.tar.gz
Algorithm Hash digest
SHA256 1ff4afcf95b288ed76ae16e218e8c11986ea85354d2e426f139563f52b0f5a3b
MD5 635061a437a3ccbeae71b739bbdccc34
BLAKE2b-256 7c8cc15d4866e305548ad518a9781c34dd9c270e593581e7ef0c19e96b086263

See more details on using hashes here.

Provenance

The following attestation bundles were made for hledger_textual-0.2.9.tar.gz:

Publisher: publish.yml on thesmokinator/hledger-textual

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

File details

Details for the file hledger_textual-0.2.9-py3-none-any.whl.

File metadata

File hashes

Hashes for hledger_textual-0.2.9-py3-none-any.whl
Algorithm Hash digest
SHA256 07d22448ad0559005af34e5d08eb2b43931a45b74e8b22e9208711afca1771ec
MD5 dd2b1b59773d713af2be137bdb31d26c
BLAKE2b-256 121dd087fda1013f526e1a64eecf9d433426c3b1b57278de70f8f96e5780bac3

See more details on using hashes here.

Provenance

The following attestation bundles were made for hledger_textual-0.2.9-py3-none-any.whl:

Publisher: publish.yml on thesmokinator/hledger-textual

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