Skip to main content

A collection of plugins for Beancount

Project description

beancount-reds-plugins

A collection of plugins for Beancount, software for plain text, double entry bookkeeping. See README.md in individual directories for plugin specific documentation.

Plugin list:

  • autoclose_tree: automatically closes all of an account's descendants when an account is closed.
  • capital_gains_classifier: rebooks capital gains into separate long and short accounts, and separate gains and losses accounts
  • effective_date: enables per-posting dates (each posting in a transaction can have a different date)
  • opengroup: Inserts open statements for sets of accounts based on specifiable rules.
  • rename_accounts: rename arbitrary accounts on the fly (eg: move Taxes from Expenses to Income when you temporarily want to view all your Expenses except taxes)
  • zerosum: find matching pairs of postings that sum up to zero. Useful in de-duplication, and tracking things such as reimbursements, rebates, etc.

Installation

pip3 install beancount-reds-plugins

Or to install the bleeding edge version from git:

pip3 install git+https://github.com/redstreet/beancount_reds_plugins

Usage

Invoke and configure a plugin by including it in your beancount source. For example, invoke the rename_accounts plugin like so:

plugin "beancount_reds_plugins.rename_accounts.rename_accounts" "{
 'Expenses:Taxes' : 'Income:Taxes',
 }"

See README.md in individual directories for how to configure each plugin.

Disabling plugins during the import process

In general, no plugins should run on the source files that are passed to smart_importer. Here's an article that shows how.

In short (this is for zsh, adapt to your shell as needed):

bean-extract my.import -f <(echo 'plugin "beancount.plugins.auto_accounts"'; cat ${INGEST_ROOT}/../source/*) $file

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

beancount_reds_plugins-0.4.0.tar.gz (53.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

beancount_reds_plugins-0.4.0-py3-none-any.whl (55.2 kB view details)

Uploaded Python 3

File details

Details for the file beancount_reds_plugins-0.4.0.tar.gz.

File metadata

  • Download URL: beancount_reds_plugins-0.4.0.tar.gz
  • Upload date:
  • Size: 53.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.5

File hashes

Hashes for beancount_reds_plugins-0.4.0.tar.gz
Algorithm Hash digest
SHA256 33ed652d9d08c6c1de472900d92a7695f6b5f864c3ad23812acd68e756ed0565
MD5 3c1ecf13de15c39bdd2ac4ed42c63a36
BLAKE2b-256 679348ef31e6c6ed5f09896947a0b40eaf2ad69d15b9a9687b6a94596aa9a249

See more details on using hashes here.

File details

Details for the file beancount_reds_plugins-0.4.0-py3-none-any.whl.

File metadata

File hashes

Hashes for beancount_reds_plugins-0.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 186d4d625dcd094043b489f942d44b8cb603a2d5710083e0ce2ea56c2dd133fa
MD5 acccf333061bdfdb3e43123296ce3f42
BLAKE2b-256 55ab307c9b30229f6e75fcad14008e06291d93452b577ebd50412c1f30c0df49

See more details on using hashes here.

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