`config`

This module provides the configuration for python accounting. Its properties are populated from config.toml by default and should be adequate for most settings, but there are a few methods for overriding the database, hashing and dates configurations. For more extensive custom configurations, you can initialize the class with a custom config.tml file.

Module Contents

Classes

Config

Python Accounting configuration class.

Attributes

`default_configuration`
`config`	The default configuration

class config.Config(config_file)

Python Accounting configuration class.

database: dict

The database configuration.

{
    url (str): The database connection string. Defaults to 'sqlite://'.
    echo (bool): Whether to output the SqlAlchemy generated queries to the console.
    Defaults to false.
    include_deleted (bool): Whether to include soft deleted records in query results.
    Defaults to false.
    ignore_isolation (bool): Whether to include records from all entities in query
    results.
    Defaults to false.
}

hashing: dict

Configuration for hashing Ledger records to guard against direct database tampering.

{
    salt (str): The initial value for the ledger hashing. Defaults to 'hashing salt'.
    algorithm (str): The Algorithm to use for encoding the hashes. Defaults to 'sha256'.
}

dates: dict

Configuration for formatting dates in reports.

{
    short (str): The format for short dates. Defaults to '%Y-%m-%d'.
    long (str): The format for long dates. Defaults to '%d, %b %Y'.
}

accounts: dict

Account Types, Codes and Financial Report section membership Configuration

{
    types (dict): The Account Types as defined by GAAP/IFRS:
    label (str): The human readable name of the Account Type.
    account_code (int): The starting point for the genaration of Account Codes for
    Accounts of the type.
    purchasables (list): Account types that can be used in purchasing Transations.
}

transactions: dict

Transaction Types, Number Prefixes and clearable/assignable Configuration

{
    types (`dict`): The Transaction Types as defined by GAAP/IFRS
    label (`str`): The human readable name of the Transaction Type.
    transaction_no_prefix (`int`): The code to be inserted at the beginningof the
    Transaction's type's sequentially generated transaction number.
    clearables (`list`): Transaction types that can cleared by assignable Transactions.
    assignables (`list`): Transaction types that can user to cleared (have assigned
    to them) clearable Transactions.
}

reports: dict

Configuration for Financial Reports.

{
    indent_length (`int`): Number of spaces to indent report sections. Defaults to 4.
    result_length (`int`): Number of characters to underline report results. Defaults
    to 15.
    aging_schedule_brackets (`dict`): The labels and max age in days for aging schedule
    brackets.
}

configure_database(url, echo=False, include_deleted=False, ignore_isolation=False) → None

Configures the database.

Parameters:

url (str) – The database connection string.
echo (bool) – Whether to output the SqlAlchemy generated queries to the console. Defaults to false.
include_deleted (bool) – Whether to include soft deleted records in query results. Defaults to false.
ignore_isolation (bool) – Whether to include records from all entities in query results. Defaults to false.

configure_hashing(salt='hashing salt', algorithm='sha256') → None

Configures hashing.

Parameters:

salt (str) – The initial value for the ledger hashing. Defaults to ‘hashing salt’.
algorithm (str) – The Algorithm to use for encoding the hashes. Defaults to ‘sha256’.

configure_dates(short='%Y-%m-%d', long='%d, %b %Y') → None

Configures dates.

Parameters:

short (str) – The format for short dates. Defaults to ‘%Y-%m-%d’.
long (str) – The format for long dates. Defaults to ‘%d, %b %Y’.

config.default_configuration

config.config: The default configuration

config

Module Contents

Classes

Attributes

`config`