NPO-Accounting/conservancy_beancount Files · README.rst

Files @ 83e6e80bb89c

Branch filter:

Location: NPO-Accounting/conservancy_beancount/README.rst

83e6e80bb89c 955 B text/x-rst Show Annotation Show as Raw Download as Raw

bkuhn

meta_payroll_type — US:PTO — distinguish between Earned and Taken

Metadata `payroll-type` will go on `Liabilities:Payable:Vacation` and
`Expenses:Payroll:Salary`, but we need to distinguish as to whether
the Payroll was earned or taken.

Later, `Liabilities:Payable:Vacation` should require a
`payroll-type` metadata of either `US:PTO:Taken` or `US:PTO:Earned`,
and the `CA:` equivalents.

Beancount plugin and tools for Conservancy's books
==================================================

Introduction
------------

This repository includes code that Software Freedom Conservancy uses to keep its books in Beancount. It includes:

* A Beancount plugin to validate that transactions are documented according to business rules, and normalize "enum-like" metadata we have defined
* A set of financial business reports from the books
* Related tools to help with audit and tax reporting

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.

Development
-----------

``doc/Development.rst`` explains how to work on this code, including an overview of how modules are organized.

Legal
-----

Refer to ``LICENSE.txt`` for details.