Skip to main content

A rich web interface for the CL-accounting tool beancount.

Project description

https://img.shields.io/badge/plaintextaccounting.org-beancount-red.svg https://img.shields.io/pypi/l/beancount-fava.svg https://img.shields.io/pypi/v/beancount-fava.svg https://img.shields.io/pypi/dm/beancount-fava.svg https://img.shields.io/github/commits-since/aumayr/fava/v0.2.4.svg https://img.shields.io/travis/aumayr/fava.svg

Web interface for the double-entry bookkeeping software beancount with a focus on features and usability.

You can try out a demo here: fava.pythonanywhere.com

https://raw.githubusercontent.com/aumayr/fava/master/util/screenshots/screenshot-01.png

(More Screenshots here: github.com/aumayr/fava/tree/master/util/screenshots)

Installation

  1. Prerequisites: An installed version of beancount and Python >= 3.5

  2. Install it from PyPI by running pip3 install beancount-fava

Usage

  1. Start fava by running fava /Volumes/Ledger/example.ledger (substitute with the path to your own beancount-file) to run the included web server.

  2. Point your browser at http://localhost:5000 to view the web interface.

fava comes with Gmail-style keyboard shortcuts: Press ? to show an overview of the keyboard shortcuts.

Development

If you want to hack on fava, this will get you up and running:

git clone https://github.com/aumayr/fava.git
cd fava
# using a virtual environment is optional, but recommended
virtualenv -p python3 venv
. venv/bin/activate
make build-js
pip install --editable .

Note that you’ll need to have the newest version of npm and NodeJS installed to build the JavaScript and CSS files.


Caution: Consider this beta-software. Contributions are very welcome :-)

Project details


Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page