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

Uploaded Python 3

File details

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

File metadata

  • Download URL: hledger_textual-0.2.7.tar.gz
  • Upload date:
  • Size: 111.7 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.7.tar.gz
Algorithm Hash digest
SHA256 ad90194bd6f09b7aa87cae0bca1f4034882d68c76381944041ac2cb5c12eb364
MD5 46d5fc740ceea6833e1261fc11f73153
BLAKE2b-256 e96babef782f4afd383621e78c9ae23668c0dcf6d7a9b3e0bedb94809ab66bd4

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for hledger_textual-0.2.7-py3-none-any.whl
Algorithm Hash digest
SHA256 70167ba1f6c7ad44bd3bce08cb5138002962cc7ca5f229f91e3ff716365a7a6f
MD5 306d4df799e839104ef0df2d5a769ea4
BLAKE2b-256 f7244ca98c4f7bfc0e931edf0ac4f9fe1c51e82ef62edc15f79eb68246678fce

See more details on using hashes here.

Provenance

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