def setup(**kwargs):
"""
The setup method that is being called from generated manage.py scripts.
This setup method is similar in spirit to the setup.py's setup() call
present in most python projects. It takes any keyword arguments and tries
to make the best of it.
:param kwargs:
arbitrary keyword arguments, see below for what we currently look up
:raises:
SystemExit with the exit code of the program. This is done regardless
of normal / abnormal termination.
The following keyword parameters are supported:
name:
name of the provider (IQN compatible). Typically something like
``2013.org.example:some-name`` where the ``some-name`` is a simple
identifier and a private namespace for whoever owned
``org.example`` in ``2013``
version:
version string, required
description:
description (may be long/multi line), optional
gettext_domain:
gettext translation domain for job definition strings, optional
"""
setup_logging()
manage_py = inspect.stack()[1][0].f_globals['__file__']
location = os.path.dirname(os.path.abspath(manage_py))
definition = Provider1Definition()
try:
definition.location = location
definition.name = kwargs.get('name', None)
definition.version = kwargs.get('version', None)
definition.description = kwargs.get('description', None)
definition.gettext_domain = kwargs.get('gettext_domain', Unset)
except ConfigValidationError as exc:
raise SystemExit(
_("{}: bad value of {!r}, {}").format(manage_py, exc.variable.name,
exc.message))
else:
raise SystemExit(ProviderManagerTool(definition).main())
def setup(**kwargs):
"""
The setup method that is being called from generated manage.py scripts.
This setup method is similar in spirit to the setup.py's setup() call
present in most python projects. It takes any keyword arguments and tries
to make the best of it.
:param kwargs:
arbitrary keyword arguments, see below for what we currently look up
:raises:
SystemExit with the exit code of the program. This is done regardless
of normal / abnormal termination.
The following keyword parameters are supported:
name:
name of the provider (IQN compatible). Typically something like
``2013.org.example:some-name`` where the ``some-name`` is a simple
identifier and a private namespace for whoever owned
``org.example`` in ``2013``
version:
version string, required
description:
description (may be long/multi line), optional
gettext_domain:
gettext translation domain for job definition strings, optional
"""
setup_logging()
manage_py = inspect.stack()[1][0].f_globals['__file__']
location = os.path.dirname(os.path.abspath(manage_py))
definition = Provider1Definition()
try:
definition.location = location
definition.name = kwargs.get('name', None)
definition.version = kwargs.get('version', None)
definition.description = kwargs.get('description', None)
definition.gettext_domain = kwargs.get('gettext_domain', Unset)
except ConfigValidationError as exc:
raise SystemExit(_("{}: bad value of {!r}, {}").format(
manage_py, exc.variable.name, exc.message))
else:
raise SystemExit(ProviderManagerTool(definition).main())
Get the version reported by this executable
"""
return "{}.{}.{}".format(*version[:3])
def add_subcommands(self, subparsers):
"""
Add top-level subcommands to the argument parser.
This can be overriden by subclasses to use a different set of
top-level subcommands.
"""
# TODO: switch to plainbox plugins
RunCommand(self._provider).register_parser(subparsers)
SelfTestCommand().register_parser(subparsers)
SRUCommand(self._provider, self._config).register_parser(subparsers)
CheckConfigCommand(self._config).register_parser(subparsers)
DevCommand(self._provider, self._config).register_parser(subparsers)
ServiceCommand(self._provider,
self._config).register_parser(subparsers)
def main(argv=None):
raise SystemExit(PlainBoxTool().main(argv))
# Setup logging before anything else starts working.
# If we do it in main() or some other place then unit tests will see
# "leaked" log files which are really closed when the runtime shuts
# down but not when the tests are finishing
setup_logging()
DevCommand(self._provider_list, self._config).register_parser(
subparsers)
StartProviderCommand().register_parser(subparsers)
@classmethod
def get_config_cls(cls):
"""
Get the Config class that is used by this implementation.
This can be overridden by subclasses to use a different config
class that is suitable for the particular application.
"""
return PlainBoxConfig
def get_gettext_domain(self):
return "plainbox"
def get_locale_dir(self):
return os.getenv("PLAINBOX_LOCALE_DIR", None)
def main(argv=None):
raise SystemExit(PlainBoxTool().main(argv))
# Setup logging before anything else starts working.
# If we do it in main() or some other place then unit tests will see
# "leaked" log files which are really closed when the runtime shuts
# down but not when the tests are finishing
setup_logging()
