Skip to main content

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

Project description

hledger-textual

PyPI GitHub Release CI Coverage

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.3.3.tar.gz (116.8 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.3.3-py3-none-any.whl (155.9 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for hledger_textual-0.3.3.tar.gz
Algorithm Hash digest
SHA256 86d7c6b2f4e8c1012d4223b2a293b3ed1e5108d7bec59b8210e374b343f63d5c
MD5 1f8d22ecf8d3e5af011b39dfc717bae2
BLAKE2b-256 dab60453673538dd50f5c0d0f031832925bfc94b3b51912d8c9ed2395787a70a

See more details on using hashes here.

Provenance

The following attestation bundles were made for hledger_textual-0.3.3.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.3.3-py3-none-any.whl.

File metadata

  • Download URL: hledger_textual-0.3.3-py3-none-any.whl
  • Upload date:
  • Size: 155.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for hledger_textual-0.3.3-py3-none-any.whl
Algorithm Hash digest
SHA256 07a035601bef8b9e097f6a356fb1c95a0d614b0cc3e097d4584e49ab5d7705ca
MD5 8e322929c09f843cd15ea38671691697
BLAKE2b-256 9a98480152ff4a42e8d1888abd6c3c9a34f8efc2c952760aecf39710311facdb

See more details on using hashes here.

Provenance

The following attestation bundles were made for hledger_textual-0.3.3-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