Plugin, library, and reports for reading Conservancy's books
|
||
---|---|---|
conservancy_beancount | ||
doc | ||
tests | ||
.gitignore | ||
AGPLv3.txt | ||
LICENSE.txt | ||
MANIFEST.in | ||
pyproject.toml | ||
README.rst | ||
setup.cfg | ||
setup.py |
Beancount plugin and tools for Conservancy's books ================================================== Introduction ------------ This repository includes code that Software Freedom Conservancy uses to keep its books in Beancount. It includes: * A Beancount plugin to validate that transactions are documented according to business rules, and normalize "enum-like" metadata we have defined * A set of financial business reports from the books * Related tools to help with audit and tax reporting Installation ------------ ``cd`` to this directory with your checkout and then run:: python3 -m pip install --user --upgrade . Of course, if you're familiar with Python development tools, you're welcome to install the module in a virtualenv, somewhere else, etc. Development ----------- ``doc/Development.rst`` explains how to work on this code, including an overview of how modules are organized. Legal ----- Refer to ``LICENSE.txt`` for details.