NPO-Accounting/experimental-accounting-api
6
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
experimental-accounting-api
41 commits 1 branch 0 tags 650 KiB
JavaScript 92.6%
Python 6.7%
HTML 0.7%
Find a file
Joar Wandborg fc2c3a6b43 [license] Added notice to all python files
2013-12-17 15:41:30 +01:00
accounting [license] Added notice to all python files 2013-12-17 15:41:30 +01:00
bin Added ./bin/gtkclient 2013-12-16 07:38:00 +01:00
doc Add compiled documentation to tree 2013-12-17 09:42:53 +01:00
tests Addded tests/ folder with example payloads 2013-12-16 07:38:45 +01:00
AGPLv3 Rename LICENSE file to AGPLv3. 2013-12-17 07:52:57 -05:00
LICENSE Added sphinx license 2013-12-17 15:30:12 +01:00
non-profit-test-data.ledger Added transaction IDs and metadata 2013-12-11 15:12:08 +01:00
README.rst Updated README 2013-12-12 22:25:31 +01:00
requirements.txt Added SQL requirements 2013-12-16 07:39:38 +01:00
SPHINX-LICENSE Added sphinx license 2013-12-17 15:30:12 +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