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	bf09cebf7352	3 years ago	query: Add overview docstring.
Brett Smith	c3e0cc869bcc	3 years ago	query: Improve help text in interactive shell.
Brett Smith	741e6628943d	3 years ago	query: Add original query as a comment to ODS output. query: Add original query as a comment to ODS output. This is generally helpful to keep for future reference, plus this presentation can support multiple queries and is more discoverable than the previous file property.
Brett Smith	ea10fb239f57	3 years ago	query: Add a user hint for query TypeErrors. query: Add a user hint for query TypeErrors. The error message that native bean-query provides when this happens confuses many users. Add a hint to point them in the right direction.
Brett Smith	c5a2c2d39b6d	3 years ago	query: Development cleanup. query: Development cleanup. Reorder classes for nicer readability. Put shorter classes higher up, keep related classes together. Add developer-facing comments. Remove unused imports.
Brett Smith	5893d6a59a2b	3 years ago	query: Add --calendar-year and --fiscal-year shortcuts.
Brett Smith	6fa12789661e	3 years ago	query: Improve formatting of ODS output. query: Improve formatting of ODS output. * Provide dedicated formatting for more Beancount types. * Improve code to determine when we're looking up link metadata and should format output as links.
Brett Smith	8af45e5f8a5b	3 years ago	query: Add BQL functions for dealing with link metadata. query: Add BQL functions for dealing with link metadata. query-report was heading to a place where it was going to bifurcate. You could structure input with its own special input switches, and with ODS output, it would have its own dedicated grouping logic and use that. But those things shouldn't be tied together for users. Instead, add functions to BQL to be able to do the kind of grouping we want. This commit adds those. Next we'll extend the ODS output to detect and format these groups correctly.
Brett Smith	0f58960b67f7	3 years ago	query: Add ODS output format.
Brett Smith	0b3175fe6b12	3 years ago	query: Add support for --numberify. query: Add support for --numberify. bean-query compatibility.

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.