NPO-Accounting/conservancy_beancount
6
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
Plugin, library, and reports for reading Conservancy's books
114 commits 1 branch 0 tags 995 KiB
Python 100%
Find a file
Brett Smith bce438167c meta_approval: Required when payables are accrued. RT#10259.
2020-04-05 14:49:16 -04:00
conservancy_beancount meta_approval: Required when payables are accrued. RT#10259. 2020-04-05 14:49:16 -04:00
tests meta_approval: Required when payables are accrued. RT#10259. 2020-04-05 14:49:16 -04:00
.gitignore gitignore: Add .mypy_cache. 2020-03-15 10:25:10 -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 README: Add basic installation instructions. 2020-04-02 11:49:35 -04:00
setup.cfg setup: Disallow untyped calls. 2020-03-29 23:22:35 -04:00
setup.py meta_entity: Adjust what entities are allowed based on today's books. 2020-04-01 13:38:37 -04:00

README.rst 

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