Plugin, library, and reports for reading Conservancy's books
Find a file
2022-03-01 23:09:50 +11:00
conservancy_beancount reconcile: Add prototype CSV reconciliation report. 2022-03-01 23:09:50 +11:00
doc doc: Document installation into a virtualenv. 2022-02-04 19:27:58 +11:00
tests reconcile: Add further typing info; update tests. 2022-02-24 22:43:37 +11: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: Document installation into a virtualenv. 2022-02-04 19:27:58 +11:00
setup.cfg Add typing dependencies for requests, dateutil, setuptools and yaml. 2022-02-04 19:24:02 +11: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 .

For development, a Python virtual environment may be more appropriate. See the development documentation for details.

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.