xobox Package API¶
The xobox
package itself provides some constants and functions documented in
the sections below. Apart from mirroring functionality already existing deeper within the
xobox
package (for easier access), no functionality shall be implemented at
this level.
-
xobox.
COPYRIGHT
= ('2017', 'the Stormrose Project team')¶ Official copyright information for the
xobox
package
-
xobox.
APPINFO
= ('Stormrose', 'xobox')¶ Official app name and author
-
xobox.
get_version
(*args, **kwargs)[source]¶ Function providing the official version information for a xobox installation.
Currently, this is a mirror of
xobox.utils.version.get_version()
, provided for convenience, e. g. for easier use in a setup script or similar.Warning
Since the implementation of this function may change in the future, always use this function and not
xobox.utils.version.get_version()
when retrieving official version information.
-
xobox.
get_development_status
(*args, **kwargs)[source]¶ Function providing the official development status for a xobox installation.
Currently, this is a mirror of
xobox.utils.version.get_development_status()
, provided for convenience, e. g. for easier use in a setup script or similar.Warning
Since the implementation of this function may change in the future, always use this function and not
xobox.utils.version.get_development_status()
when retrieving official development status information.
-
xobox.
get_app_name
(*args, **kwargs)[source]¶ Function providing the official application name for xobox.
This information is mainly required to construct configuration and data paths, etc. This function is a wrapper function provided for convenience, ensuring a consistent interface to this information.
Function providing the official author name for xobox.
This information is mainly required to construct configuration and data paths, etc. This function is a wrapper function provided for convenience, ensuring a consistent interface to this information.