Top-Level Modules¶
This module contains documentation for the top-level modules in the
topchef package.
Initializer¶
Contains the source for the topchef package
Main Module¶
The base module of entry for the application. This module contains the command line argument parser, allowing for starting and maintaining the server from the CLI. This is meant to be used when starting the app from the Flask development server.
Note
This module is intended for use only when running the application direct
from the command line. If this application is going to be run through a
web server like Apache, it is recommended to use the APP_FACTORY
variable in topchef.wsgi_app.
-
class
topchef.__main__.TopchefManager(app_factory_constructor: topchef.wsgi_app.WSGIAppFactory = <topchef.wsgi_app.ProductionWSGIAppFactory object>, db_engine_factory: topchef.wsgi_app.DatabaseEngineFactory = <topchef.wsgi_app.ProductionWSGIAppFactory object>) → None[source]¶ The flask-script manager that is to be used in
-
__init__(app_factory_constructor: topchef.wsgi_app.WSGIAppFactory = <topchef.wsgi_app.ProductionWSGIAppFactory object>, db_engine_factory: topchef.wsgi_app.DatabaseEngineFactory = <topchef.wsgi_app.ProductionWSGIAppFactory object>) → None[source]¶ Parameters: app_factory_constructor – The application factory to use for running this manager.
-
Config¶
Contains user-serviceable configuration parameters
JSON Type¶
WSGI App¶
Contains the factories for making the WSGI application that handles HTTP requests.
The web server gateway interface (WSGI) is an API for web application servers like Apache to call Python programs in order to execute HTTP methods. It accomplishes an equivalent role as Java’s servlet API, enabling multiple web frameworks to use the same web server.
Flask is a web framework built on top of WSGI
for making dynamic web applications. At its core is an application object of
type Flask that maps WSGI to plain Python functions. This module takes
care of generating this flask application.