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
------------
...
@@ -10,30 +19,10 @@ Installation
Of course, if you're familiar with Python development tools, you're welcome to install the module in a virtualenv, somewhere else, etc.
Running all tests
-----------------
The project comes with a Tox configuration that defines all the tests we expect to pass, across all the different environments we support. To run them all, run::
tox
The next sections describe how to run them standalone in your own development environment, for faster iteration or simpler isolation of problems.
Running unit tests
------------------
Run::
pytest
Type checking
-------------
Most of the code is typed, except for very dynamic loader methods. To run the type checker::
mypy conservancy_beancount
Development
-----------
Thisisexpected to passjustliketheunittests.
``doc/Development.rst`` explains how to work on this code, including an overview of how modules are organized.