Plugin, library, and reports for reading Conservancy's books
Find a file
2021-05-03 14:14:25 -04:00
conservancy_beancount cliutil: Add docstrings throughout. 2021-04-29 11:49:46 -04:00
doc doc: Add Development. 2021-05-03 14:14:25 -04:00
tests reports: BaseODS puts each line of strings in a P tag. 2021-03-15 13:19:03 -04:00
.gitignore setup: Switch to PEP 517 build system. 2021-03-31 16:42:29 -04:00
AGPLv3.txt Clarify and organize license info including additional permission. 2021-01-08 16:58:04 -05:00
LICENSE.txt setup: New release for pdfforms tools. 2021-01-09 10:11:56 -05:00
MANIFEST.in typing: Add PEP 561 py.typed file 2021-03-31 16:41:32 -04:00
pyproject.toml setup: Switch to PEP 517 build system. 2021-03-31 16:42:29 -04:00
README.rst doc: Add Development. 2021-05-03 14:14:25 -04:00
setup.cfg query: Let the user interrupt interactive queries. 2021-04-01 09:57:42 -04:00
setup.py setup: Switch to PEP 517 build system. 2021-03-31 16:42:29 -04:00

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.