Metadata-Version: 2.0
Name: beancount-fava
Version: 0.2.5
Summary: A rich web interface for the CL-accounting tool beancount.
Home-page: http://github.com/aumayr/fava
Author: Dominik Aumayr
Author-email: dominik@aumayr.name
License: MIT
Keywords: fava beancount beancount-fava beancount-web ledger ledger-cli cl-accounting
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Web Environment
Classifier: Framework :: Flask
Classifier: Intended Audience :: Education
Classifier: Intended Audience :: End Users/Desktop
Classifier: Intended Audience :: Financial and Insurance Industry
Classifier: Intended Audience :: Information Technology
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Programming Language :: JavaScript
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
Classifier: Topic :: Office/Business :: Financial :: Accounting
Classifier: Topic :: Office/Business :: Financial :: Investment
Requires-Dist: Flask (>=0.10.1)
Requires-Dist: beancount (>=2.0b6)
Requires-Dist: beancount-pygments-lexer (>=0.1.2)
Requires-Dist: livereload (>=2.4.1)
Requires-Dist: markdown2 (>=2.3.0)
Requires-Dist: pyexcel (>=0.2.0)
Requires-Dist: pyexcel-ods3 (>=0.1.1)
Requires-Dist: pyexcel-xls (>=0.1.0)
Requires-Dist: pyexcel-xlsx (>=0.1.0)
Requires-Dist: pygments (>=2.1.1)

fava
====

.. image:: https://img.shields.io/badge/plaintextaccounting.org-beancount-red.svg
   :target: http://plaintextaccounting.org
.. image:: https://img.shields.io/pypi/l/beancount-fava.svg
   :target: https://pypi.python.org/pypi/beancount-fava
.. image:: https://img.shields.io/pypi/v/beancount-fava.svg
   :target: https://pypi.python.org/pypi/beancount-fava
.. image:: https://img.shields.io/pypi/dm/beancount-fava.svg
   :target: https://pypi.python.org/pypi/beancount-fava
.. image:: https://img.shields.io/github/commits-since/aumayr/fava/v0.2.5.svg
   :target: https://github.com/aumayr/fava/compare/v0.2.5...master
.. image:: https://img.shields.io/travis/aumayr/fava.svg
   :target: https://travis-ci.org/aumayr/fava?branch=master

Web interface for the double-entry bookkeeping software
`beancount <http://furius.ca/beancount/>`__ with a focus on features and
usability.

You can try out a demo here:
`fava.pythonanywhere.com <http://fava.pythonanywhere.com>`__

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

(More Screenshots here:
`github.com/aumayr/fava/tree/master/util/screenshots <https://github.com/aumayr/fava/tree/master/util/screenshots>`__)

Installation
------------

1. Prerequisites: An installed version of
   `beancount <http://furius.ca/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:

.. code:: bash

    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 :-)


