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.13.tar.gz (114.7 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.13-py3-none-any.whl (154.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: hledger_textual-0.2.13.tar.gz
  • Upload date:
  • Size: 114.7 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.2.13.tar.gz
Algorithm Hash digest
SHA256 993824946ff821faaf9b52be08583841a38e8f37d2c920d439ab5277537bf577
MD5 1032e6ba053dec076425b4da74b1ea45
BLAKE2b-256 3846759af420883af68ea6beedcfab29e2abbaac9c11a0d66524f0a6badb3a12

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for hledger_textual-0.2.13-py3-none-any.whl
Algorithm Hash digest
SHA256 78e2577480bfb9f8553ac668e9e73d44abe617c410267253bf96d3c69380c294
MD5 6249943e6ff6a45d6a2eaaf057886cef
BLAKE2b-256 60aea1c07786f2b50a06e0405405ed79a2f06a485e52248500e8679feacb5fae

See more details on using hashes here.

Provenance

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