Plugin, library, and reports for reading Conservancy's books
Find a file
Brett Smith 7702a1f03c fund: Add bottom line totals to Fund Report. RT#4582.
This required keeping the balances from write_row, and then a lot of other
changes followed from that. In particular it makes more sense to build the
fund report sheet from scratch rather than copying the breakdowns report and
chiseling the fund report out of it.
2020-07-01 15:56:39 -04:00
conservancy_beancount fund: Add bottom line totals to Fund Report. RT#4582. 2020-07-01 15:56:39 -04:00
tests fund: Add bottom line totals to Fund Report. RT#4582. 2020-07-01 15:56:39 -04:00
.gitignore tox: Start configuration to test on Py3.6 and Py3.7. 2020-04-06 15:25:14 -04:00
LICENSE.txt Initial commit: license, setup.py, gitignore, skeleton structure. 2020-03-05 09:33:23 -05:00
pytest.ini tests: Ignore the DeprecationWarning from the socks module. 2020-03-24 09:16:38 -04:00
README.rst tox: Start configuration to test on Py3.6 and Py3.7. 2020-04-06 15:25:14 -04:00
setup.cfg setup: Move tox.ini to setup.cfg. 2020-06-03 22:27:49 -04:00
setup.py accrual: Wire is a single payment method. 2020-07-01 13:43:58 -04:00

Beancount plugin and tools for Conservancy's books
==================================================

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.

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::

  ./setup.py test

Type checking
-------------

Most of the code is typed, except for very dynamic loader methods. To run the type checker::

  ./setup.py typecheck

This is expected to pass just like the unit tests.

Legal
-----

Copyright © 2020  Brett Smith. Licensed under the `GNU Affero General Public License <https://www.gnu.org/licenses/agpl-3.0.html>`_, either version 3 of the License, or (at your option) any later version.