Skip to main content

Payee verification plugin for Beancount

Project description

beancount payeeverif

beancount_payeeverif is the "payee verification" plugin for beancount, fulfilling the following functions:

  1. Every transaction has a non-NULL payee field:

    ; this will throw an error
    2020-06-01  *   ""   "fix faucet leak"
      Expenses:General
      Assets:Bank -150 bean
    
    ; this will pass validation
    2020-06-02  *   "plumber"   "fix faucet leak"
      Expenses:General
      Assets:Bank -150 bean
    
  2. TODO: coming soon Transactions touching certain accounts must match an allowed_payees regex.

installation

pip install beancount_payeeverif

usage

In your toplevel .beancount file, include:

plugin  "beancount_payeeverif"

See the .beancount files in test for examples.

developing

Install package and dev requirements locally:

python3 -m pip install -e .[dev]

Run tests:

python3 -m pytest

Build both binary and source distributions locally:

python3 setup.py bdist_wheel sdist

See sanitize.sh for maintainer's personal tooling.

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_payeeverif-1.0.2.tar.gz (5.4 kB view hashes)

Uploaded Source

Built Distribution

beancount_payeeverif-1.0.2-py3-none-any.whl (3.4 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page