Files
@ 96b39a877816
Branch filter:
Location: NPO-Accounting/conservancy_beancount/README.rst - annotation
96b39a877816
1.2 KiB
text/x-rst
beancount_types: OptionsMap is a dict.
While mutating it is *probably* not a good idea, I've gotten to a point
where I need to do that (to update a value), so just admit the truth here.
While mutating it is *probably* not a good idea, I've gotten to a point
where I need to do that (to update a value), so just admit the truth here.
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 f8ea5ce62c6a f8ea5ce62c6a f8ea5ce62c6a f8ea5ce62c6a f8ea5ce62c6a f8ea5ce62c6a f8ea5ce62c6a f8ea5ce62c6a f8ea5ce62c6a f8ea5ce62c6a f8ea5ce62c6a f8ea5ce62c6a f8ea5ce62c6a f8ea5ce62c6a 188063cbb7a5 | 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::
./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, 2021 Brett Smith and others. Licensed under the GNU Affero General Public License, either version 3 of the License, or (at your option) any later version; with an additional permission. Refer to ``LICENSE.txt`` for details.
|