kepler package¶
Subpackages¶
- kepler.api package
- Submodules
- kepler.api.api_doc module
- kepler.api.api_util module
- kepler.api.calendar module
- kepler.api.common module
- kepler.api.email_util module
- kepler.api.event module
- kepler.api.ical module
- kepler.api.notice_board module
- kepler.api.oauth module
- kepler.api.permission module
- kepler.api.reservation module
- kepler.api.resource module
- kepler.api.role module
- kepler.api.time_slot module
- kepler.api.time_util module
- kepler.api.translation_util module
- kepler.api.unit module
- kepler.api.unit_group module
- kepler.api.user module
- kepler.api.user_group module
- Module contents
- Submodules
- kepler.models package
- Submodules
- kepler.models.constants module
- kepler.models.models_meta module
- kepler.models.note module
- kepler.models.permission module
- kepler.models.reservation module
- kepler.models.resource module
- kepler.models.role module
- kepler.models.time_slot module
- kepler.models.translation module
- kepler.models.unit module
- kepler.models.user module
- kepler.models.user_group module
- Module contents
- Submodules
- kepler.scripts package
Submodules¶
Module contents¶
The module is the main Kepler server application module. It contains the application entry point that setups the application and starts serving it.
-
kepler.
generate_rest_api_doc
()¶ The function generates the Kepler REST API documentation source for inclusion in the source code documentation.
-
kepler.
get_user
(request)¶ The function gets the
User
model of the currently authenticated user from the database.Parameters: request – The Pyramid request object. Returns: User correspondin to the currently authenticated user, or None
, if no user with the ID is found in the database or no user is authenticated.
-
kepler.
main
(global_config, **settings)¶ The function is the entry point of Kepler server application.
-
kepler.
make_get_tr
(translations)¶ The function makes the
request.tr
method used to get translations for UI and API strings.Parameters: translations – The Translations
object that contains the UI and API translations.Returns: The function that will be added to the request objects as method.
-
kepler.
setup_view_routes
(config)¶ The function setups view routes of the application.
Parameters: config – The application configuration (an instance of Configurator
class).