2020-03-18 20:21:06 +00:00
|
|
|
Beancount plugin and tools for Conservancy's books
|
|
|
|
|
==================================================
|
|
|
|
|
|
2021-05-03 18:14:25 +00:00
|
|
|
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
|
|
|
|
|
|
2020-04-02 15:49:35 +00:00
|
|
|
Installation
|
|
|
|
|
------------
|
|
|
|
|
|
|
|
|
|
``cd`` to this directory with your checkout and then run::
|
|
|
|
|
|
|
|
|
|
python3 -m pip install --user --upgrade .
|
|
|
|
|
|
2022-02-04 08:26:31 +00:00
|
|
|
For development, a Python virtual environment may be more appropriate. See the development documentation for details.
|
2020-04-02 15:49:35 +00:00
|
|
|
|
2021-05-03 18:14:25 +00:00
|
|
|
Development
|
|
|
|
|
-----------
|
2020-03-18 20:21:06 +00:00
|
|
|
|
2021-05-03 18:14:25 +00:00
|
|
|
``doc/Development.rst`` explains how to work on this code, including an overview of how modules are organized.
|
2020-03-18 20:21:06 +00:00
|
|
|
|
|
|
|
|
Legal
|
|
|
|
|
-----
|
|
|
|
|
|
2021-03-31 20:42:29 +00:00
|
|
|
Refer to ``LICENSE.txt`` for details.
|
