diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..285031e --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +/doc/build/* +!/doc/build/html diff --git a/doc/build/html/README.html b/doc/build/html/README.html new file mode 100644 index 0000000..1faa330 --- /dev/null +++ b/doc/build/html/README.html @@ -0,0 +1,204 @@ + + + + +
+ + +To run the GTK client you need to have gi.repository avaiable in the python +environment, this means that if you use virtualenv to install the dependencies +of accounting-api you need to set it up with the --system-site-packages +flag.
+accounting-api does not yet have a method for end-user installation. This +section describes how you would set up accounting-api for development purposes, +which can also be used as an environment to try out the functionality of +accounting-api.
+See the sections below on how to install the dependencies. Then run the +following in your shell.
+# Get the source code
+git clone git://gitorious.org/conservancy/accounting-api.git
+cd accounting-api
+
+# Set up the python 3.3 virtualenv (this will make the GTK client not work)
+mkvirtualenv -p /usr/bin/python3.3 accounting-api
+# OR If you want the GTK client to work
+mkvirtualenv -p /usr/bin/python3.3 --system-site-packages accounting-api
+
+# If your terminal prompt does not say "(accounting-api)", run
+workon accounting-api
+
+# Install the python packages
+pip-3.3 install -r requirements.txt
+
If all went well, head to Usage. If not, head to the channel #npoacct +on irc.freenode.net.
+# git python 3.3 and virtualenvwrapper
+sudo apt-get install git-core python3.3 virtualenvwrapper
+
+# ledger 3
+sudo apt-add-repository ppa:mbudde/ledger
+sudo apt-get update
+sudo apt-get install ledger
+
# Run the web service
+LEDGER_FILE=../path/to/your.ledger ./bin/serve
+
+# Get a balance report via the web service
+./bin/client balance
+
+# Get the transaction log
+./bin/client register
+
+# Insert a simple transaction, currency will be autodetected from your
+# locale, for another currency, use ``--symbol USD``
+./bin/client insert "January rent" Assets:Checking Expenses:Rent 654.32
+