Source documentation

almir – Main package

almir.forms – HTML forms definitions

almir.meta – Configuration for models

class almir.meta.ModelMixin

Bases: object

static format_byte_size(size)

classmethod get_list(**kw)

classmethod get_one(id_=None, query=None)

query = None

static render_distance_of_time_in_words(dt_from, dt_to=None)

almir.meta.get_database_size(engine)

Returns human formatted SQL database size.

Example: 3.04 GB

almir.meta.initialize_sql(settings)

almir.models – SQLAlchemy models

almir.views – Pyramid views

almir.lib – Non MVC code

almir.lib.bacula_base64 – Bacula custom base64 implmentation

Taken from https://github.com/ZungBang/baculafs/blob/master/baculafs/Base64.py under GPLv3

almir.lib.bacula_base64.decode_base64(base64)

Bacula specific implementation of a base64 decoder

almir.lib.bconsole – Python interface to bconsole

class almir.lib.bconsole.BConsole(bconsole_command='bconsole -n -c %s', config_file=None)

Bases: object

Interface to bconsole binary

classmethod from_temp_config(*args, **kwds)

Constructs BConsole object with help of passing temporary file for the session.

get_jobs_settings()

get_upcoming_jobs(days=1)

get_version()

is_running()

make_backup(job, level=None, storage=None, fileset=None, client=None, priority=None, pool=None, when=None)

send_command_by_polling(command, process=None)

start_process()

exception almir.lib.bconsole.BConsoleError

Bases: exceptions.Exception

exception almir.lib.bconsole.DirectorNotRunning

Bases: almir.lib.bconsole.BConsoleError

almir.lib.console_commands – Parsed list of bconsole commands

almir.lib.sqlalchemy_custom_types

class almir.lib.sqlalchemy_custom_types.BaculaDateTime(*args, **kwargs)

Bases: sqlalchemy.types.TypeDecorator

Changes sqlite DateTime to parse 0 values as no value. Also converts to right timezone

impl

alias of DateTime

process_result_value(value, dialect=None)

result_processor(dialect, coltype)

almir.lib.sqlalchemy_declarative_reflection

class almir.lib.sqlalchemy_declarative_reflection.DeclarativeReflectedBase

Bases: object

classmethod prepare(engine)

Reflect all the tables and map !

almir.lib.sqlalchemy_lowercase_inspector

class almir.lib.sqlalchemy_lowercase_inspector.LowerCaseInspector(bind)

Bases: sqlalchemy.engine.reflection.Inspector

Implements reflection inspector that reflects everything lowercase

get_columns(*a, **kw)

get_foreign_keys(*a, **kw)

get_indexes(*a, **kw)

get_pk_constraint(*a, **kw)

almir.lib.utils - General utilities

almir.lib.utils.convert_timezone(datetime)

Converts datetime to timezone aware datetime.

Retrieving timezone:

• get timezone from .ini settings
• default to system timezone

almir.lib.utils.get_jinja_macro(macro)

Return actual function from a jinja2 template

almir.lib.utils.nl2br(text)

almir.lib.utils.render_rst_section(filename)

Finds filename in documentation directory and renders it to html.

almir.lib.utils.timedelta_to_seconds(td)

almir.lib.utils.yesno(text)

almir.scripts – Runnable scripts package

almir.scripts.configure_deploy – Ask few questions and configure almir

Dirty script to output buildout.cfg, but it does the job.

almir.scripts.configure_deploy.ask_question(question, default=None, validator=None, func=<built-in function raw_input>)

almir.scripts.configure_deploy.main()

Entry point of this script

almir.scripts.configure_deploy.validate_engine(v)

almir.scripts.configure_deploy.validate_int(v)

almir.scripts.configure_deploy.validate_open_port(v)

almir.scripts.configure_deploy.validate_timezone(v)

almir.scripts.parse_console_commands – Parse help commands from bconsole source

almir.scripts.parse_console_commands.main()

almir.scripts.parse_console_commands.parse_console_commands(source)

almir.tests – Tests package

almir.tests.test_functional – Functional tests