For development, a Python virtual environment may be more appropriate. See the development documentation for details.

Installing

~~~~~~~~~~

Create a virtual environment, for example::

  python3 -m venv ~/.virtualenvs/conservancy-beancount

Install the ``conservancy_beancount`` as an editable package including the test dependencies::

  ~/.virtualenvs/conservancy-beancount/bin/python -m pip install --editable ~/conservancy/conservancy_beancount[test]

Alternatively, you can run ``tox`` which will run the tests in a clean virtual

environment with all the relevant dependencies.

  # Beancount includes type declarations but not the `py.typed` flag file mypy

  # is looking for to know that. Create it ourselves.

  python -c 'import beancount, pathlib; pathlib.Path(beancount.__file__).with_name("py.typed").touch()'

When Beancount sees this directive after loading all the data, it passes everything it loaded through the ``run`` function in ``conservancy_beancount/plugin/__init__.py`` to be manipulated. Our ``run`` function, in turn, passes the data through hooks defined in other files under ``conservancy_beancount/plugin`` to normalize data and report errors. ``HookRegistry`` in ``__init__.py`` is the bridge between these two. It supports dynamically choosing which hooks are loaded at runtime, although we currently aren't using that.