python-gunicorn-service

Description

Setup a service executing an application from within a virtualenv.

NOTE: Currently, this frecklet will only work if the user that is specified has their home directory under '/home/'.

Variables

Name Type Default Description

app_module

n/a --

The entry point. Required

project_name

n/a --

n/a Required

group

string ::value_from_project_name::

The name of the group to own the service.

If not provided, the project name will be used, and a user with that name will be created if necessary. If the project name contains a whitespace or other invalid character, this will fail.

pip_extra_args

string --

Extra arguments forwarded to 'pip'.

project_config

dict ordereddict()

Environment variables to configure app.

python_packages

list []

All necessary Python packages.

python_version

string latest

The version of python.

user

string ::value_from_project_name::

The name of the user to own the service.

If not provided, the project name will be used, and a user with that name will be created if necessary.

Command-line

frecklecute python-gunicorn-service --help

Usage: frecklecute python-gunicorn-service [OPTIONS]

  Setup a service executing an application from within a virtualenv.

  **NOTE**: Currently, this frecklet will only work if the user that is
  specified has their home directory under '/home/<username>'.

Options:
  --app-module APP_MODULE         The entry point.  [required]
  --project-name PROJECT_NAME     n/a  [required]
  --group GROUP                   The name of the group to own the service
                                  (defaults to project name).
  --pip-extra-args PIP_EXTRA_ARGS
                                  Extra arguments forwarded to 'pip'.
  --project-config PROJECT_CONFIG
                                  Environment variables to configure app.
  -p, --python-pkg PYTHON_PACKAGES
                                  All necessary Python packages.
  --python-version PYTHON_VERSION
                                  The version of python.
  --user USER                     The name of the user to own the service
                                  (defaults to project name).
  --help                          Show this message and exit.