Plugin, library, and reports for reading Conservancy's books
Find a file
Brett Smith e1c507c025 plugin.core: Less introspective DIRECTIVE setting.
Python 3.6 does not implement __class_getitem__, and because of that
it's not possible to introspect when things like Hook[Transaction]
are called. Sidestep the issue with a more explicit assignment.
2020-04-06 15:18:54 -04:00
conservancy_beancount plugin.core: Less introspective DIRECTIVE setting. 2020-04-06 15:18:54 -04:00
tests test_meta_invoice: Add explicit "missing invoice" tests. 2020-04-06 10:15:17 -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 setup: Add overlooked PyYAML dependency. 2020-04-06 14:32:41 -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 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.