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

Uploaded Python 3

File details

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

File metadata

  • Download URL: hledger_textual-0.3.6.tar.gz
  • Upload date:
  • Size: 121.5 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.6.tar.gz
Algorithm Hash digest
SHA256 244e415d12aa997c3ba488a00a6d9561a620d4d655cf42b7e55b886d1563c606
MD5 b3b6dc688b3d30cfddd26f891eb7eed1
BLAKE2b-256 9fffd7fa634a3def644c4921d4a2f373393956f1cb8407f560d2a51967b5b276

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: hledger_textual-0.3.6-py3-none-any.whl
  • Upload date:
  • Size: 161.6 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.6-py3-none-any.whl
Algorithm Hash digest
SHA256 ace58b1b5a8c5b473cada7374333c8326402f81b2d0dfd3640621d134070552f
MD5 51c073a649f1d05521ad2856e45b2fd4
BLAKE2b-256 b72c93734862b1c5e3594f78f2d5c99783ed1d932df8c34d4e5eb9e633585a7b

See more details on using hashes here.

Provenance

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