Skip to content
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Go to file
Cannot retrieve contributors at this time
53 lines (39 sloc) 1.88 KB

Custom Application

.. versionadded:: 19.0

Sometimes, you want to integrate Gunicorn with your WSGI application. In this case, you can inherit from :class:``.

Here is a small example where we create a very small WSGI app and load it with a custom Application:

.. literalinclude:: ../../examples/
    :start-after: # See the NOTICE for more information
    :lines: 2-

Direct Usage of Existing WSGI Apps

If necessary, you can run Gunicorn straight from Python, allowing you to specify a WSGI-compatible application at runtime. This can be handy for rolling deploys or in the case of using PEX files to deploy your application, as the app and Gunicorn can be bundled in the same PEX file. Gunicorn has this functionality built-in as a first class citizen known as :class:``. This can be used to run WSGI-compatible app instances such as those produced by Flask or Django. Assuming your WSGI API package is exampleapi, and your application instance is app, this is all you need to get going: exampleapi:app

This command will work with any Gunicorn CLI parameters or a config file - just pass them along as if you're directly giving them to Gunicorn:

# Custom parameters
$ python exampleapi:app --bind= --workers=4
# Using a config file
$ python exampleapi:app -c

Note for those using PEX: use -c gunicorn as your entry at build time, and your compiled app should work with the entry point passed to it at run time.

# Generic pex build command via bash from root of exampleapi project
$ pex . -v -c gunicorn -o compiledapp.pex
# Running it
./compiledapp.pex exampleapi:app -c