https://github.com/akerl/libledger

Library for reading and writing Ledger transactions
https://github.com/akerl/libledger

Last synced: 2 months ago
JSON representation

Library for reading and writing Ledger transactions

• Host: GitHub
• URL: https://github.com/akerl/libledger
• Owner: akerl
• License: mit
• Created: 2016-04-25T00:57:45.000Z (over 8 years ago)
• Default Branch: main
• Last Pushed: 2023-07-07T22:41:39.000Z (over 1 year ago)
• Last Synced: 2024-09-22T07:18:36.775Z (4 months ago)
• Language: Ruby
• Homepage:
• Size: 43.9 KB
• Stars: 6
• Watchers: 3
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-starred - akerl/libledger - Library for reading and writing Ledger transactions (others)

README

        
libledger

=========

[![Gem Version](https://img.shields.io/gem/v/libledger.svg)](https://rubygems.org/gems/libledger)

[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/akerl/libledger/build.yml?branch=main)](https://github.com/akerl/libledger/actions)

[![MIT Licensed](https://img.shields.io/badge/license-MIT-green.svg)](https://tldrlegal.com/license/mit-license)

Library for interacting with [Ledger](http://www.ledger-cli.org/) files.

## Usage

libledger provides Ledger::Entry, which is a transaction, and Ledger::Journal, a list of transactions.

To create a new entry:

```

require 'libledger'

require 'date'

entry = Ledger::Entry.new(

  name: 'Delicious Chipotle Burrito',

  state: :cleared,

  date: Date.today,

  actions: [

    { name: 'Expenses:Burritos', amount: '$6.89' },

    { name: 'Assets:visa' }

  ]

)

# This will print the entry in ledger format

puts entry

```

To read an entry, call `Ledger::Entry.from_lines(lines)`. `lines` should be an array of strings, which are the lines of a ledger journal for that transaction.

To read a full journal, use `Ledger::Journal.from_file(file)`, where file should be a path to the journal file. If you have multiple files, `Ledger::Journal.from_files(files)` accepts an array of paths.

To create a journal, use `Ledger::Journal.new(entries: array_of_entries)`.

The output of `.to_s` on a Journal (which is called if you do `puts my_journal` is the ledger text file format for its transactions.

## Installation

    gem install libledger

## License

libledger is released under the MIT License. See the bundled LICENSE file for details.