Files
@ 4fce6b4feaa7
Branch filter:
Location: NPO-Accounting/experimental-accounting-api/doc/build/html/README.html - annotation
4fce6b4feaa7
8.3 KiB
text/html
[tests] Added bin/runtests
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 | f9b9aff4a92a f9b9aff4a92a f9b9aff4a92a f9b9aff4a92a f9b9aff4a92a f9b9aff4a92a f9b9aff4a92a f9b9aff4a92a 0e72c2b54373 f9b9aff4a92a 36d91dd0b398 f9b9aff4a92a f9b9aff4a92a f9b9aff4a92a f9b9aff4a92a f9b9aff4a92a f9b9aff4a92a f9b9aff4a92a f9b9aff4a92a f9b9aff4a92a f9b9aff4a92a f9b9aff4a92a f9b9aff4a92a f9b9aff4a92a f9b9aff4a92a f9b9aff4a92a 0e72c2b54373 0e72c2b54373 36d91dd0b398 36d91dd0b398 36d91dd0b398 36d91dd0b398 f9b9aff4a92a f9b9aff4a92a 36d91dd0b398 36d91dd0b398 36d91dd0b398 f9b9aff4a92a f9b9aff4a92a f9b9aff4a92a f9b9aff4a92a f9b9aff4a92a f9b9aff4a92a f9b9aff4a92a 3378805b80ee 3378805b80ee 36d91dd0b398 36d91dd0b398 36d91dd0b398 3378805b80ee 0e72c2b54373 f9b9aff4a92a f9b9aff4a92a 0e72c2b54373 f9b9aff4a92a f9b9aff4a92a f9b9aff4a92a f9b9aff4a92a f9b9aff4a92a f9b9aff4a92a f9b9aff4a92a f9b9aff4a92a f9b9aff4a92a f9b9aff4a92a 0e72c2b54373 0e72c2b54373 f9b9aff4a92a f9b9aff4a92a f9b9aff4a92a f9b9aff4a92a f9b9aff4a92a f9b9aff4a92a f9b9aff4a92a f9b9aff4a92a f9b9aff4a92a f9b9aff4a92a f9b9aff4a92a f9b9aff4a92a f9b9aff4a92a f9b9aff4a92a f9b9aff4a92a f9b9aff4a92a f9b9aff4a92a f9b9aff4a92a f9b9aff4a92a f9b9aff4a92a f9b9aff4a92a f9b9aff4a92a f9b9aff4a92a f9b9aff4a92a f9b9aff4a92a f9b9aff4a92a f9b9aff4a92a f9b9aff4a92a f9b9aff4a92a f9b9aff4a92a f9b9aff4a92a f9b9aff4a92a f9b9aff4a92a f9b9aff4a92a f9b9aff4a92a f9b9aff4a92a f9b9aff4a92a f9b9aff4a92a f9b9aff4a92a f9b9aff4a92a f9b9aff4a92a f9b9aff4a92a f9b9aff4a92a f9b9aff4a92a f9b9aff4a92a f9b9aff4a92a f9b9aff4a92a f9b9aff4a92a f9b9aff4a92a f9b9aff4a92a f9b9aff4a92a f9b9aff4a92a f9b9aff4a92a f9b9aff4a92a f9b9aff4a92a f9b9aff4a92a f9b9aff4a92a f9b9aff4a92a f9b9aff4a92a f9b9aff4a92a f9b9aff4a92a f9b9aff4a92a f9b9aff4a92a f9b9aff4a92a f9b9aff4a92a f9b9aff4a92a f9b9aff4a92a f9b9aff4a92a f9b9aff4a92a f9b9aff4a92a f9b9aff4a92a f9b9aff4a92a f9b9aff4a92a f9b9aff4a92a f9b9aff4a92a f9b9aff4a92a f9b9aff4a92a f9b9aff4a92a f9b9aff4a92a f9b9aff4a92a 36d91dd0b398 36d91dd0b398 36d91dd0b398 f9b9aff4a92a f9b9aff4a92a 0e72c2b54373 f9b9aff4a92a f9b9aff4a92a f9b9aff4a92a f9b9aff4a92a f9b9aff4a92a f9b9aff4a92a f9b9aff4a92a f9b9aff4a92a f9b9aff4a92a f9b9aff4a92a f9b9aff4a92a f9b9aff4a92a 36d91dd0b398 36d91dd0b398 36d91dd0b398 0e72c2b54373 0e72c2b54373 36d91dd0b398 36d91dd0b398 f9b9aff4a92a f9b9aff4a92a f9b9aff4a92a f9b9aff4a92a f9b9aff4a92a f9b9aff4a92a f9b9aff4a92a f9b9aff4a92a f9b9aff4a92a f9b9aff4a92a f9b9aff4a92a f9b9aff4a92a f9b9aff4a92a f9b9aff4a92a f9b9aff4a92a f9b9aff4a92a f9b9aff4a92a f9b9aff4a92a f9b9aff4a92a f9b9aff4a92a f9b9aff4a92a f9b9aff4a92a 36d91dd0b398 36d91dd0b398 36d91dd0b398 36d91dd0b398 36d91dd0b398 f9b9aff4a92a f9b9aff4a92a | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>accounting-api README — Accounting API 0.1-beta documentation</title>
<link rel="stylesheet" href="_static/flasky.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '0.1-beta',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="top" title="Accounting API 0.1-beta documentation" href="index.html" />
<link rel="next" title="REST API Documentation" href="restapi.html" />
<link rel="prev" title="Accounting API - Documentation" href="index.html" />
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9">
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="http-routingtable.html" title="HTTP Routing Table"
>routing table</a> |</li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="restapi.html" title="REST API Documentation"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="index.html" title="Accounting API - Documentation"
accesskey="P">previous</a> |</li>
<li><a href="index.html">Accounting API 0.1-beta documentation</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="accounting-api-readme">
<h1>accounting-api README<a class="headerlink" href="#accounting-api-readme" title="Permalink to this headline">¶</a></h1>
<div class="section" id="dependencies">
<h2>Dependencies<a class="headerlink" href="#dependencies" title="Permalink to this headline">¶</a></h2>
<ul class="simple">
<li>Python >=3.3</li>
<li>ledger version 3 (I have not tried with version 2.x)</li>
<li>Python packages: Flask, etc. (install by running <tt class="docutils literal"><span class="pre">pip</span> <span class="pre">install</span> <span class="pre">-r</span>
<span class="pre">requirements.txt</span></tt>)</li>
</ul>
<div class="section" id="gtk-client-dependencies">
<h3>GTK Client Dependencies<a class="headerlink" href="#gtk-client-dependencies" title="Permalink to this headline">¶</a></h3>
<p>To run the GTK client you need to have <tt class="docutils literal"><span class="pre">gi.repository</span></tt> 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 <tt class="docutils literal"><span class="pre">--system-site-packages</span></tt>
flag.</p>
</div>
</div>
<div class="section" id="installation-i-e-development-setup">
<h2>Installation (i.e. Development Setup)<a class="headerlink" href="#installation-i-e-development-setup" title="Permalink to this headline">¶</a></h2>
<p>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.</p>
<p>See the sections below on how to install the dependencies. Then run the
following in your shell.</p>
<div class="highlight-bash"><div class="highlight"><pre><span class="c"># Get the source code</span>
git clone git://gitorious.org/conservancy/accounting-api.git
<span class="nb">cd </span>accounting-api
<span class="c"># Set up the python 3.3 virtualenv (this will make the GTK client not work)</span>
mkvirtualenv -p /usr/bin/python3.3 accounting-api
<span class="c"># OR If you want the GTK client to work</span>
mkvirtualenv -p /usr/bin/python3.3 --system-site-packages accounting-api
<span class="c"># If your terminal prompt does not say "(accounting-api)", run</span>
workon accounting-api
<span class="c"># Install the python packages</span>
pip-3.3 install -r requirements.txt
</pre></div>
</div>
<p>If all went well, head to <a class="reference internal" href="#usage"><em>Usage</em></a>. If not, head to the channel <tt class="docutils literal"><span class="pre">#npoacct</span></tt>
on <tt class="docutils literal"><span class="pre">irc.freenode.net</span></tt>.</p>
<div class="section" id="ubuntu">
<h3>Ubuntu<a class="headerlink" href="#ubuntu" title="Permalink to this headline">¶</a></h3>
<div class="highlight-bash"><div class="highlight"><pre><span class="c"># git python 3.3 and virtualenvwrapper</span>
sudo apt-get install git-core python3.3 virtualenvwrapper
<span class="c"># ledger 3</span>
sudo apt-add-repository ppa:mbudde/ledger
sudo apt-get update
sudo apt-get install ledger
</pre></div>
</div>
</div>
</div>
<div class="section" id="usage">
<span id="id1"></span><h2>Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h2>
<div class="highlight-bash"><div class="highlight"><pre><span class="c"># Run the web service</span>
<span class="nv">LEDGER_FILE</span><span class="o">=</span>../path/to/your.ledger ./bin/serve
<span class="c"># Get a balance report via the web service</span>
./bin/client balance
<span class="c"># Get the transaction log</span>
./bin/client register
<span class="c"># Insert a simple transaction, currency will be autodetected from your</span>
<span class="c"># locale, for another currency, use ``--symbol USD``</span>
./bin/client insert <span class="s2">"January rent"</span> Assets:Checking Expenses:Rent 654.32
</pre></div>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<p class="logo"><a href="index.html">
<img class="logo" src="_static/accounting-api-logo.png" alt="Logo"/>
</a></p>
<h3><a href="index.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">accounting-api README</a><ul>
<li><a class="reference internal" href="#dependencies">Dependencies</a><ul>
<li><a class="reference internal" href="#gtk-client-dependencies">GTK Client Dependencies</a></li>
</ul>
</li>
<li><a class="reference internal" href="#installation-i-e-development-setup">Installation (i.e. Development Setup)</a><ul>
<li><a class="reference internal" href="#ubuntu">Ubuntu</a></li>
</ul>
</li>
<li><a class="reference internal" href="#usage">Usage</a></li>
</ul>
</li>
</ul>
<h3>Related Topics</h3>
<ul>
<li><a href="index.html">Documentation overview</a><ul>
<li>Previous: <a href="index.html" title="previous chapter">Accounting API - Documentation</a></li>
<li>Next: <a href="restapi.html" title="next chapter">REST API Documentation</a></li>
</ul></li>
</ul>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/README.txt"
rel="nofollow">Show Source</a></li>
</ul>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
© Copyright 2013, Joar Wandborg.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a>.
</div>
</body>
</html>
|