API Documentation¶
bauble
¶
The top level module for Bauble.
-
bauble.
version
= '1.0.56'¶ str(object=’‘) -> string
Return a nice string representation of the object. If the argument is a string, the return value is the same object.
-
bauble.
gui
= None¶ bauble.gui is the instance
bauble.ui.GUI
-
bauble.
command_handler
(cmd, arg)¶ Call a command handler.
Parameters: - cmd (str) – The name of the command to call
- arg (list) – The arg to pass to the command handler
-
bauble.
main
(uri=None)¶ Run the main Bauble application.
Parameters: uri (str) – the URI of the database to connect to. For more information about database URIs see http://www.sqlalchemy.org/docs/05/dbengine.html#create-engine-url-arguments
-
bauble.
main_is_frozen
()¶ Return True if we are running in a py2exe environment, else return False
-
bauble.
quit
()¶ Stop all tasks and quit Bauble.
-
bauble.
save_state
()¶ Save the gui state and preferences.
bauble.db
¶
-
bauble.db.
Base
¶ All tables/mappers in Bauble which use the SQLAlchemy declarative plugin for declaring tables and mappers should derive from this class.
An instance of
sqlalchemy.ext.declarative.Base
-
bauble.db.
metadata
¶ The default metadata for all Bauble tables.
An instance of
sqlalchemy.schema.MetaData
bauble.connmgr
¶
bauble.editor
¶
bauble.i18n
¶
The i18n module defines the _() function for creating translatable strings.
_() is added to the Python builtins so there is no reason to import
this module more than once in an application. It is usually imported
in bauble
bauble.ui
¶
bauble.meta
¶
bauble.paths
¶
Access to standard paths used by Bauble.
-
bauble.paths.
main_dir
()¶ Returns the path of the bauble executable.
-
bauble.paths.
lib_dir
()¶ Returns the path of the bauble module.
-
bauble.paths.
locale_dir
()¶ Returns the root path of the locale files
-
bauble.paths.
user_dir
()¶ Returns the path to where Bauble settings should be saved.
bauble.pluginmgr
¶
bauble.prefs
¶
bauble.task
¶
bauble.types
¶
-
class
bauble.btypes.
Enum
(values, empty_to_none=False, strict=True, translations={}, **kwargs)¶ Bases:
sqlalchemy.sql.type_api.TypeDecorator
A database independent Enum type. The value is stored in the database as a Unicode string.
-
class
bauble.btypes.
Date
(*args, **kwargs)¶ Bases:
sqlalchemy.sql.type_api.TypeDecorator
A Date type that allows Date strings
-
class
bauble.btypes.
DateTime
(*args, **kwargs)¶ Bases:
sqlalchemy.sql.type_api.TypeDecorator
A DateTime type that allows strings