Files
@ 323521344ae5
Branch filter:
Location: NPO-Accounting/conservancy_beancount/README.rst - annotation
323521344ae5
1.0 KiB
text/x-rst
books: Add docstrings throughout.
f8ea5ce62c6a f8ea5ce62c6a f8ea5ce62c6a 21c7646b4192 21c7646b4192 21c7646b4192 21c7646b4192 21c7646b4192 21c7646b4192 21c7646b4192 21c7646b4192 21c7646b4192 bff3eec952f2 bff3eec952f2 bff3eec952f2 bff3eec952f2 bff3eec952f2 bff3eec952f2 bff3eec952f2 bff3eec952f2 bff3eec952f2 bff3eec952f2 bff3eec952f2 f8ea5ce62c6a f8ea5ce62c6a f8ea5ce62c6a 61091872869a f8ea5ce62c6a f8ea5ce62c6a f8ea5ce62c6a f8ea5ce62c6a f8ea5ce62c6a f8ea5ce62c6a 61091872869a f8ea5ce62c6a f8ea5ce62c6a f8ea5ce62c6a f8ea5ce62c6a f8ea5ce62c6a f8ea5ce62c6a 61091872869a | 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.
|