Skip to content

Latest commit

 

History

History
49 lines (37 loc) · 2.05 KB

README.md

File metadata and controls

49 lines (37 loc) · 2.05 KB
Raw

Build Coverage API Documentation BSD License

Go Ledger

Library and binaries to parse relatively complex Ledger files, and provide an abstract syntax tree (a full programmatic representation of the file), to be able to tweak some parts programmatically, and then write back the files to disk.

It has a few higher level APIs added by https://github.com/cschomburg and https://github.com/glasser Many thanks for your contributions!

  • ledger-go provides a few tools to interact with Ledger files, such as balance reports.

  • ledgerfmt, similar to gofmt, parses the input file, indents and aligns according to conventions, and outputs the file back, without any semantic changes or interpretation of the data.

  • ledger2json parses your Ledger file and outputs a .json file, which you can manipulate with any software.

Installation

go get -u github.com/abourget/ledger/cmd/...

Shortcomings

This implementation has a few limitations compared to the C++ version:

  • The current implementation does not validate any balances. It merely acts on the text of the file.
  • It does not yet support all top-level constructs, like "account", "alias", "P", "D", "year" / "Y", etc.. Most of those should be simple to implement.
  • It does not yet understand tags. They are only considered comments.
  • It does not yet implement the value_expr language that allows you to do complex math computations directly in the postings of your transactions. It merely store the string text of the expression, PROVIDED it is enclosed in parenthesis, e.g. (123 + 2 * 3 USD).