Plugin, library, and reports for reading Conservancy's books
e2dda7ae0c
This makes it easier to iterate on a query because you don't have to restart the program and reload the books if something goes sideways. |
||
|---|---|---|
| conservancy_beancount | ||
| tests | ||
| .gitignore | ||
| AGPLv3.txt | ||
| LICENSE.txt | ||
| MANIFEST.in | ||
| pyproject.toml | ||
| README.rst | ||
| setup.cfg | ||
| setup.py | ||
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:: pytest Type checking ------------- Most of the code is typed, except for very dynamic loader methods. To run the type checker:: mypy conservancy_beancount This is expected to pass just like the unit tests. Legal ----- Refer to ``LICENSE.txt`` for details.