8000 GitHub - xuhcc/beancount at v1
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

xuhcc/beancount

 
 

Repository files navigation

========================================================
   BeanCount: Double-Entry Accounting with Text Input
========================================================

.. contents::
..
    1  Description
    2  Project Status
    3  Demo
    4  Download
    5  Documentation
    6  Copyright and License
    7  Author

Description
===========

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).

Notes:

- The ideas and syntax is entirely inspired by John Wiegley's Ledger_,
  and the syntax is pretty much compatible with it, or at least it was
  at the time it was created. 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 use
  Beancount.

- Beancount is a Python version of Ledger, and thus is much slower,
  but also easier to extend (the code is pure Python).

- 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).

- 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.

.. _Ledger: http://www.newartisans.com/blog/projects/ledger.html


Project Status
==============

This code is stable; 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.
I've been using it for years without having to modify it
significantly. Basically, this software is 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." [Updated on 2012-08]


Demo
====

There is a demonstration ledger input file under the examples
directory. To run a local web server on the example demo file, cd into
``examples`` and run the demo scripts.

- `Demo Ledger input file <examples/demo.ledger>`_
- `Demo Output <examples/output/balsheet_end.html>`_


Download
========

A Mercurial repository can be found at:

  http://hg.furius.ca/public/beancount/

`Click here for download instructions. </web-furius/downloading.html>`_



Documentation
=============

- `CHANGES <CHANGES>`_
- `TODO <TODO>`_


Copyright and License
=====================

Copyright (C) 2007-2008  Martin Blais.  All Rights Reserved.

This code is distributed under the `GNU General Public License <COPYING>`_;


Author
======

Martin Blais <blais@furius.ca>

About

Official Beancount repository.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python 76.4%
  • HTML 331E 13.5%
  • C 6.6%
  • Lex 1.7%
  • Emacs Lisp 1.3%
  • Makefile 0.2%
  • Other 0.3%
0