beansoup.plugins package¶
Submodules¶
beansoup.plugins.clear_transactions module¶
Work in progress. It works, but needs documentation and some cleaning.
beansoup.plugins.config module¶
Utilities to help parse a plugin configuration string.
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
-
__getnewargs__
()¶ Return self as a plain tuple. Used by copy and pickle.
-
__getstate__
()¶ Exclude the OrderedDict from pickling
-
static
__new__
(_cls, source, message, entry)¶ Create new instance of DITError(source, message, entry)
-
__repr__
()¶ Return a nicely formatted representation string
-
entry
¶ Alias for field number 2
-
message
¶ Alias for field number 1
-
source
¶ Alias for field number 0
-
-
beansoup.plugins.deposit_in_transit.
open_dit_accounts
(entries, dit_component)[source]¶ Minimally adapted from beancount.plugins.auto_accounts.
-
beansoup.plugins.deposit_in_transit.
process_pair
(pair, cleared_tag, cleared_links, same_day_merge)[source]¶