2020-03-18 20:21:06 +00:00
Beancount plugin and tools for Conservancy's books
==================================================
2020-04-02 15:49:35 +00:00
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.
2020-04-06 19:25:14 +00:00
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
------------------
2020-03-18 20:21:06 +00:00
Run::
2021-03-31 20:42:29 +00:00
pytest
2020-03-18 20:21:06 +00:00
Type checking
-------------
Most of the code is typed, except for very dynamic loader methods. To run the type checker::
2021-03-31 20:42:29 +00:00
mypy conservancy_beancount
2020-03-18 20:21:06 +00:00
This is expected to pass just like the unit tests.
Legal
-----
2021-03-31 20:42:29 +00:00
Refer to `` LICENSE.txt `` for details.
