forked from mgax/beancount
-
Notifications
You must be signed in to change notification settings - Fork 0
/
index.html
108 lines (104 loc) · 5.15 KB
/
index.html
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
<?xml version="1.0" encoding="iso-8859-1" ?>
<!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" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<meta name="generator" content="Docutils 0.6: http://docutils.sourceforge.net/" />
<title>BeanCount: Command-line Double-Entry Accounting</title>
<link rel="stylesheet" href="style.css" type="text/css" />
</head>
<body>
<div id="project-header">
<a href="/"><img src="/home/furius-logo-w.png" id="logo"></a>
</div>
<div class="document" id="beancount-command-line-double-entry-accounting">
<h1 class="title">BeanCount: Command-line Double-Entry Accounting</h1>
<div class="contents topic" id="contents">
<p class="topic-title first">Contents</p>
<ul class="simple">
<li><a class="reference internal" href="#description" id="id1">Description</a></li>
<li><a class="reference internal" href="#running-the-demo" id="id2">Running the Demo</a></li>
<li><a class="reference internal" href="#download" id="id3">Download</a></li>
<li><a class="reference internal" href="#documentation" id="id4">Documentation</a></li>
<li><a class="reference internal" href="#copyright-and-license" id="id5">Copyright and License</a></li>
<li><a class="reference internal" href="#author" id="id6">Author</a></li>
</ul>
</div>
<!-- 1 Description
2 Running the Demo
3 Download
4 Documentation
5 Copyright and License
6 Author -->
<div class="section" id="description">
<h1><a class="toc-backref" href="#id1">Description</a></h1>
<p>A double-entry accounting system that uses a simple text file format
as input. A few Python scripts are used to parse the contents of the
file, for example, to serve the contents as a locally running web
server. Scripts are provided to convert from OFX files into Ledger
input format, and other formats (easily extensible).</p>
<p>Notes:</p>
<ul class="simple">
<li>The ideas and syntax is entirely inspired by John Wiegley's <a class="reference external" href="http://www.newartisans.com/blog/projects/ledger.html">Ledger</a>,
and the syntax is pretty much compatible with it. Beancount's syntax
is a subset of Ledger (a little more restrictive), with a few
additional directives. You should probably read Ledger's
documentation in order to you use Beancount.</li>
<li>Beancount is a Python version of Ledger, and thus is much slower,
but also easier to extend (the code is pure Python).</li>
<li>Beancount provides a simple web front to view the contents of the
database, so you don't have to parse the entire file everytime you
want to view a different account (this helps mitigate the fact that
parsing is comparatively slow).</li>
<li>New features can be expected to flow between Ledger and Beancount,
as the authors have been in touch and have discussed ways of doing
integration. In particular, Ledger is being augmented with the
ability to export its parser with a binding for the Python language,
so Beancount's parser may eventually use the Ledger parser for
speed, and Ledger may eventually leverage Beancount's web front-end.</li>
</ul>
<div class="important">
<p class="first admonition-title">Important</p>
<p class="last">This code works; as a testimony, I'm using it personally, actively
to manage my own finances and my company's finances, and thus I'm
running it and its components at the very least a few times montly.
If you have any problem using it, please let me know. This software
should be in a functional state; this is not abandonware, nor is it
prototyping code either. You should be able to use beancount to do
"real work" (I do).</p>
</div>
</div>
<div class="section" id="running-the-demo">
<h1><a class="toc-backref" href="#id2">Running the Demo</a></h1>
<p>There is a demonstration ledger input file under the examples
directory. To run a local web server on the example demo file, cd into
<tt class="docutils literal"><span class="pre">examples</span></tt> and run the demo scripts.</p>
</div>
<div class="section" id="download">
<h1><a class="toc-backref" href="#id3">Download</a></h1>
<p>You can obtain the Ledger source from Furius' public Mercurial
repository, by typing the following command:</p>
<pre class="literal-block">
hg clone https://hg.furius.ca/public/beancount
</pre>
</div>
<div class="section" id="documentation">
<h1><a class="toc-backref" href="#id4">Documentation</a></h1>
<ul class="simple">
<li><a class="reference external" href="examples/demo.ledger">Demo Ledger input file</a></li>
<li><a class="reference external" href="CHANGES">CHANGES</a></li>
<li><a class="reference external" href="TODO">TODO</a></li>
</ul>
</div>
<div class="section" id="copyright-and-license">
<h1><a class="toc-backref" href="#id5">Copyright and License</a></h1>
<p>Copyright (C) 2007-2008 Martin Blais. All Rights Reserved.</p>
<p>This code is distributed under the <a class="reference external" href="COPYING">GNU General Public License</a>;</p>
</div>
<div class="section" id="author">
<h1><a class="toc-backref" href="#id6">Author</a></h1>
<p>Martin Blais <<a class="reference external" href="mailto:blais@furius.ca">blais@furius.ca</a>></p>
</div>
</div>
</body>
</html>