b1e6b12b71
Added initial alembic skeleton, improved base pyramid templates, added auth db extension, etc...
84 lines
1.4 KiB
ReStructuredText
84 lines
1.4 KiB
ReStructuredText
|
|
:mod:`edbob`
|
|
============
|
|
|
|
.. automodule:: edbob
|
|
|
|
|
|
Attributes
|
|
----------
|
|
|
|
This section lists the attributes available (by default) within the root
|
|
``edbob`` namespace.
|
|
|
|
.. attribute:: config
|
|
|
|
A reference to the global :class:`AppConfigParser` instance for the
|
|
currently-running application.
|
|
|
|
.. note::
|
|
This attribute is only available after :func:`edbob.init()` has happened.
|
|
|
|
.. attribute:: inited
|
|
|
|
Boolean indicating whether or not :func:`edbob.init()` has happened.
|
|
|
|
|
|
Functions
|
|
---------
|
|
|
|
This section lists the functions available (by default) within the root
|
|
``edbob`` namespace.
|
|
|
|
Core
|
|
^^^^
|
|
|
|
The following functions are considered "core" to ``edbob``:
|
|
|
|
.. autofunction:: basic_logging
|
|
|
|
.. autofunction:: get_uuid
|
|
|
|
.. autofunction:: graft
|
|
|
|
.. autofunction:: init
|
|
|
|
.. autofunction:: load_spec
|
|
|
|
Time
|
|
^^^^
|
|
|
|
The following functions provide some convenience when working with time values:
|
|
|
|
.. autofunction:: local_time
|
|
|
|
.. autofunction:: set_timezone
|
|
|
|
.. autofunction:: utc_time
|
|
|
|
Files
|
|
^^^^^
|
|
|
|
The following functions provide some convenience when working with files and
|
|
folders:
|
|
|
|
.. autofunction:: change_newlines
|
|
|
|
.. autofunction:: count_lines
|
|
|
|
.. autofunction:: temp_path
|
|
|
|
Classes
|
|
-------
|
|
|
|
This section lists the classes available (by default) within the root ``edbob``
|
|
namespace.
|
|
|
|
.. autoclass:: Object
|
|
|
|
.. automethod:: __init__
|
|
|
|
.. automethod:: __getitem__
|
|
|
|
.. autoclass:: AppConfigParser
|
|
:members:
|