beansoup.plugins package

Submodules

beansoup.plugins.clear_transactions module

Work in progress. It works, but needs documentation and some cleaning.

class beansoup.plugins.clear_transactions.AccountPairType(entries)

Bases: object

class beansoup.plugins.clear_transactions.Processor(args)

Bases: object

clear_transaction_group(txn_postings)

clear_transactions(entries)

get_txn_clearing_posting(txn)

match_txn_postings(txn_posting, txn_posting2)

max_matching_date(txn)

beansoup.plugins.clear_transactions.clear_transactions(entries, options_map, config_string)

beansoup.plugins.config module

Utilities to help parse a plugin configuration string.

class beansoup.plugins.config.ArgumentParser(*args, **kwargs)

Bases: argparse.ArgumentParser

error(message)

exit(status=0, message=None)

exception beansoup.plugins.config.ParseError(source, message)

Bases: Exception

beansoup.plugins.config.re_type(string)

Argument type for regular expressions.

It returns a compiled regular expression if string is not empty; None, otherwise. It raises argparse.ArgumentTypeError if the string is not a valid regular expression.

beansoup.plugins.deposit_in_transit module

Work in progress. It works, but needs documentation and some cleaning.

A plugin that automatically ties split deposit-in-transit transactions.

usage: beansoup.plugins.deposit_in_transit [–dit_component NAME]

[–auto_open] [–same_day_merge] [–flag_pending] [–cleared_tag TAG] [–pending_tag TAG] [–ignored_tag TAG] [–link_prefix PREFIX] [–skip_re REGEX]

optional arguments:

--dit_component NAME
	use NAME as the component name distinguishing deposit- in-transit accounts (default: DIT)
--auto_open	automatically open deposit-in-transit accounts (default: False)
--same_day_merge
	merge same-day transactions with matching deposit-in- transit postings (default: False)
--flag_pending	annotate pending transactions with a ! flag (default: False)
--cleared_tag TAG
	tag cleared transactions with TAG (default: DEPOSITED)
--pending_tag TAG
	tag pending transactions with TAG (default: IN- TRANSIT)
--ignored_tag TAG
	ignore transactions that have a TAG tag (default: IGNORED)
--link_prefix PREFIX
	link pairs of cleared transactions with PREFIX string followed by increasing count; otherwise it uses UUIDs (default: None)
--skip_re REGEX
	disable plugin if REGEX matches any sys.argv (default: None)

class beansoup.plugins.deposit_in_transit.DITError(source, message, entry)

Bases: tuple

entry

Alias for field number 2

message

Alias for field number 1

source

Alias for field number 0

beansoup.plugins.deposit_in_transit.is_pair_mergeable(pair)

beansoup.plugins.deposit_in_transit.match_dit(dit, candidate_dits, dit_component)

beansoup.plugins.deposit_in_transit.open_dit_accounts(entries, dit_component)

Minimally adapted from beancount.plugins.auto_accounts.

beansoup.plugins.deposit_in_transit.pair_dits(dits, dit_component)

beansoup.plugins.deposit_in_transit.plugin(entries, options_map, config_string)

beansoup.plugins.deposit_in_transit.process_entries(entries, args)

beansoup.plugins.deposit_in_transit.process_pair(pair, cleared_tag, cleared_links, same_day_merge)

beansoup.plugins.deposit_in_transit.process_singleton(singleton, flag_pending, pending_tag)

beansoup.plugins.deposit_in_transit.split_entries(entries, dit_component, ignored_tag)

Module contents