Skip to main content

ledgerkit-editor

CI

A keyboard-driven terminal editor for hledger plain-text accounting journals.

Early beta — use with caution. This software is under active development and may corrupt your journal files. Always keep a backup before editing. Do not use on irreplaceable data without a recovery plan.

Built with Textual and ledgerkit.


Features

  • Full-screen text editor with hledger syntax highlighting (dates, payees, accounts, amounts, commodities, comments, directives — including P price directives, field-by-field)
  • Monokai Pro default theme; runtime theme switching supported
  • Incremental search with match highlighting (Ctrl+F, Shift+PgUp/Down, Ctrl+C to copy the current match)
  • View filter — show all / cleared-only / unreconciled-only transactions (Ctrl+L)
  • Transaction block selection and duplication (Ctrl+T, Ctrl+G)
  • Cleared status toggle — single transaction (3-state cycle) and bulk selection (Ctrl+R)
  • Insert today's date at cursor (Ctrl+D)
  • Date shifting with Shift+Up / Shift+Down (cursor-position-aware; works on transaction headers and P price directives; expands an unpadded date like 2026-9-1 to 2026-09-01 on first use)
  • Save with date-sort and whitespace re-alignment (Ctrl+S)
  • Undo / Redo (Ctrl+Z / Ctrl+Y)
  • Command palette (Ctrl+P)

Planned / In Progress

See ROADMAP.md for the full, current status — it's the source of truth this section summarizes, not the other way around.

  • Transaction filter (Ctrl+O) with smart dates and regex — implemented on the unreleased release/1.1.0 branch; the latest PyPI release still has only the UI stub (criteria filtering not yet active)
  • Tab autocomplete for account/payee names — also on release/1.1.0, unreleased
  • Alt+P / Alt+N transaction templates, month/year date-shift modifiers, large-journal performance — not yet started

No side-panel features (account balance tree, transaction register, reconciliation mode) are currently planned — they existed pre-v0.8.0 and were removed; see ROADMAP.md's "Window Panes" note.


Installation

From PyPI

pip install ledgerkit-editor
ledgerkit-editor path/to/my.journal

Development setup

git clone https://github.com/ctosullivan/ledgerkit-editor.git
cd ledgerkit-editor

python -m venv .venv
.venv\Scripts\activate        # Windows
# source .venv/bin/activate   # macOS / Linux

pip install --upgrade pip
pip install -e ".[dev]"

# Run tests
pytest --tb=short

# Launch
ledgerkit-editor path/to/my.journal

Journal File Resolution

The editor resolves the journal file in this order:

  1. Path passed as a command-line argument
  2. $LEDGER_FILE environment variable
  3. ~/.hledger.journal default
  4. Interactive prompt on launch (if none of the above resolve)

Keyboard Shortcuts

See docs/shortcuts.md for the full reference.


Requirements

  • Python 3.9+
  • textual 8.2.5
  • ledgerkit 1.0.0.dev1

Development

See CONTRIBUTING.md for setup instructions and the ledgerkit dependency update workflow.

Roadmap

See ROADMAP.md for planned features and current development status.


This repository was previously named PyLedger-editor. GitHub redirects old URLs automatically.

Metadata

Release files for ledgerkit-editor 1.1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for ledgerkit-editor 1.1.0
File Size Uploaded
ledgerkit_editor-1.1.0.tar.gz 102.0 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for ledgerkit-editor 1.1.0
File Interpreter ABI Platform
ledgerkit_editor-1.1.0-py3-none-any.whl Python 3 none any Details

Total release size: 182.7 kB

Release files / ledgerkit_editor-1.1.0.tar.gz

Download URL ledgerkit_editor-1.1.0.tar.gz
Size 102.0 kB
Tags Source
SHA-256 checksum
How to use checksums
8e3d7f03fbd582d7f6d4393769c92f21fa7dc92cc0e88a723047b8659ec625d2
BLAKE2b-256 checksum
How to use checksums
ffd769a2a52bd1d1ed6d38a6637b16b25fb0e5ae62bd83b5bdd8ba331dc46324
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Sep 9, 2026.

Transparency log

Release files / ledgerkit_editor-1.1.0-py3-none-any.whl

Download URL ledgerkit_editor-1.1.0-py3-none-any.whl
Size 80.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
6a5eed57ac88a18e6c6f848cdade26c1419cc1f9e9c564bf6c1226c00dbb3a3a
BLAKE2b-256 checksum
How to use checksums
043ae04b6db9a2b27629ccd220d5e69f3c43831af21ad997b8f3129b3f6de343
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Sep 9, 2026.

Transparency log

Release history Release notifications | RSS feed

1.2.0

2 release files

1.1.1

2 release files

This release

1.1.0 This release

2 release files

1.0.2

2 release files

1.0.1

2 release files

1.0.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page