Summary

Clone URL:

git Use ID

Description:

Plugin, library, and reports for reading Conservancy's books

Trending files:

Statistics are disabled for this repository

Download:

Downloads are disabled for this repository

Latest Changes

Brett Smith	6c89febb9059	3 years ago	fund: Clean up accidental carry-overs from ledger-report docstring.
Brett Smith	ccbc447a353d	3 years ago	query: Start new reporting tool. query: Start new reporting tool. Ultimately this is going to be a tool that can generate nicely-formatted spreadsheets from arbitrary bean-queries. This initial version doesn't generate spreadsheets yet, but it does integrate our usual books-loading tools and rewrite rules into existing bean-query functionality, so it's a start. It also has some of the query building and parsing that higher-level spreadsheets will need.
Brett Smith	5231a1784f87	3 years ago	cliutil: EnumArgument matches user arguments against aliases.
Brett Smith	ee2bd6c09693	3 years ago	books: All tools use books.Loader.dispatch() and LoadResult. books: All tools use books.Loader.dispatch() and LoadResult. This is significant code deduplication, as seen in the diffstat.
Brett Smith	3721226d17fe	3 years ago	books: Add Loader.dispatch() classmethod.
Brett Smith	f3c3ebcf59e2	3 years ago	books: Add LoadResult NamedTuple. books: Add LoadResult NamedTuple. This refactors out some common functionality from our CLI tools.
Brett Smith	0a34ed6798bb	3 years ago	cliutil: ExceptHook catches RewriteRuleError. cliutil: ExceptHook catches RewriteRuleError. Now that we have richer exceptions, this is the easiest way to refactor out rewrite rule error handling from the various main functions where it currenly lives.
Brett Smith	f508df06c162	3 years ago	rewrite: Richer exceptions for error reporting.
Brett Smith	4de5df9035f6	3 years ago	typing: Upgrade more Posting Iterables to Iterators.
Brett Smith	b142b3e521be	3 years ago	accrual: Use EnumArgument for ReportType.

README.rst

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

<tt class="docutils literal">cd</tt> to this directory with your checkout and then run:

python3 -m pip install --user --upgrade .

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

Development

<tt class="docutils literal">doc/Development.rst</tt> explains how to work on this code, including an overview of how modules are organized.

Legal

Refer to <tt class="docutils literal">LICENSE.txt</tt> for details.