NPO-Accounting/experimental-accounting-api
7
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
experimental-accounting-api
18 commits 1 branch 0 tags 650 KiB
Find a file
Joar Wandborg f0652d4897 Added sphinx to requirements.txt
2013-12-12 15:11:31 +01:00
accounting Added sphinx documentation, added and inproved docstrings 2013-12-12 15:09:53 +01:00
bin Added client, other fixes 2013-12-11 09:25:55 +01:00
doc Added sphinx documentation, added and inproved docstrings 2013-12-12 15:09:53 +01:00
non-profit-test-data.ledger Added transaction IDs and metadata 2013-12-11 15:12:08 +01:00
README.rst Updated README, included more test data. 2013-12-11 09:32:35 +01:00
requirements.txt Added sphinx to requirements.txt 2013-12-12 15:11:31 +01:00

README.rst 

====================
 The Accounting API
====================

--------------
 Dependencies
--------------

-   ledger-cli version 3 (I have not tried with version 2.x)
-   Flask (install by running ``pip install -r requirements.txt``).


-------
 Usage
-------

.. code-block:: bash

    # Run the web service
    LEDGER_FILE=../path/to/your.ledger ./bin/serve

    # Get a balance report via the web service
    ./bin/client --balance