Plugin, library, and reports for reading Conservancy's books
Find a file
Ben Sturmfels 9129a4af6a
Pin to Beancount v2
Beancount v3 has been recently released. It's a major rewrite and is currently
unstable and not compatible with this codebase. We need to remain on v2.
2024-07-18 21:49:54 +10:00
conservancy_beancount statement_reconciler: switch to generator expression 2024-07-18 21:49:08 +10:00
doc doc: Document installation into a virtualenv. 2022-02-04 19:27:58 +11:00
tests reconciler: Fix reconciler lumping unmatched books items together (#20737) 2023-02-11 18:54:52 +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 Pin to Beancount v2 2024-07-18 21:49:54 +10: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.