accounting package

Subpackages

• accounting.storage package
  • Subpackages
    • accounting.storage.sql package
      • Submodules
      • accounting.storage.sql.models module
      • Module contents
  • Submodules
  • accounting.storage.ledgercli module
  • Module contents

Submodules

accounting.client module

class accounting.client.Client(host=None, json_encoder=None, json_decoder=None)

Bases: builtins.object

get(path)

get_balance()

get_register()

post(path, payload, **kw)

simple_transaction(from_acc, to_acc, amount, symbol=None, payee=None)

accounting.client.main(argv=None, prog=None)

accounting.client.print_balance_accounts(accounts, level=0)

accounting.client.print_transactions(transactions)

accounting.config module

accounting.decorators module

accounting.decorators.jsonify_exceptions(func)

Wraps a Flask endpoint and catches any AccountingException-based exceptions which are returned to the client as JSON.

accounting.exceptions module

exception accounting.exceptions.AccountingException

Bases: builtins.Exception

Used as a base for exceptions that are returned to the caller via the jsonify_exceptions decorator

accounting.gtkclient module

class accounting.gtkclient.AccountingApplication

Bases: builtins.object

load_ui(path)

on_about_dialog_response(widget, response_type)

on_show_about_activate(widget)

on_transaction_refresh_activate(widget)

on_transaction_view_cursor_changed(widget)

on_transactions_loaded(transactions)

accounting.gtkclient.indicate_activity(func_or_str)

accounting.gtkclient.indicate_activity_done(func)

accounting.gtkclient.main(argv=None)

accounting.models module

class accounting.models.Account(name=None, amounts=None, accounts=None)

Bases: builtins.object

class accounting.models.Amount(amount=None, symbol=None)

Bases: builtins.object

class accounting.models.Posting(account=None, amount=None, metadata=None)

Bases: builtins.object

class accounting.models.Transaction(id=None, date=None, payee=None, postings=None, metadata=None, _generate_id=False)

Bases: builtins.object

generate_id()

accounting.transport module

class accounting.transport.AccountingDecoder

Bases: flask.json.JSONDecoder

dict_to_object(d)

class accounting.transport.AccountingEncoder(skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, sort_keys=False, indent=None, separators=None, default=None)

Bases: flask.json.JSONEncoder

default(o)

accounting.web module

This module contains the high-level webservice logic such as the Flask setup and the Flask endpoints.

accounting.web.index()

Hello World!

accounting.web.init_ledger()

flask.Flask.before_request()-decorated method that initializes an accounting.Ledger object.

accounting.web.main(argv=None)

accounting.web.transaction_get()

Returns the JSON-serialized output of accounting.Ledger.reg()

accounting.web.transaction_post()

REST/JSON endpoint for transactions.

Current state:

Takes a POST request with a transactions JSON payload and writes it to the ledger file.

Requires the transactions payload to be __type__-annotated:

{
  "transactions": [
    {
      "__type__": "Transaction",
      "date": "2013-01-01",
      "payee": "Kindly T. Donor",
      "postings": [
        {
          "__type__": "Posting",
          "account": "Income:Foo:Donation",
          "amount": {
            "__type__": "Amount",
            "amount": "-100",
            "symbol": "$"
          }
        },
        {
          "__type__": "Posting",
          "account": "Assets:Checking",
          "amount": {
            "__type__": "Amount",
            "amount": "100",
            "symbol": "$"
          }
        }
      ]
    }
}

becomes:

2013-01-01 Kindly T. Donor
  Income:Foo:Donation                                         $ -100
  Assets:Checking                                              $ 100

accounting.web.transaction_update(transaction_id=None)

Module contents