Pyramid

To run apps built with the Pyramid web framework using Unit:

Install Unit with a Python 3 language module.

Create a virtual environment to install Pyramid`s PIP package, for instance:

$ cd /path/to/app/  # Path to the application directory; use a real path in your configuration
$ python --version  # Make sure your virtual environment version matches the module version
      Python X.Y.Z  # Major version, minor version, and revision number
$ python -m venv venv  # Arbitrary name of the virtual environment
$ source venv/bin/activate  # Name of the virtual environment from the previous command
$ pip install <package>
$ deactivate

Warning:
Create your virtual environment with a Python version that matches the language module from Step 1 up to the minor number (X.Y in this example). Also, the app type in Step 5 must resolve to a similarly matching version; Unit doesn’t infer it from the environment.

Here, $VENV isn’t set because Unit picks up the virtual environment from home in Step 5.

Let’s see how the apps from the Pyramid tutorial run on Unit.

Single-File
INI-Based

We modify the tutorial app saving it as /path/to/app/wsgi.py:

from pyramid.config import Configurator
from pyramid.response import Response

def hello_world(request):
   return Response('<body><h1>Hello, World!</h1></body>')

with Configurator() as config:
   config.add_route('hello', '/')
   config.add_view(hello_world, route_name='hello')

# Callables' name is used in Unit configuration
app = config.make_wsgi_app()

# serve(app, host='0.0.0.0', port=6543)

Note that we’ve dropped the server code; also, mind that Unit imports the module, so the if name == ‘main’ idiom would be irrelevant.

To load the configuration, we place a wsgi.py file next to development.ini in /path/to/app/:

from pyramid.paster import get_app, setup_logging

# Callables' name is used in Unit configuration
app = get_app('development.ini')
setup_logging('development.ini')

This sets up the WSGI application for Unit; if the .ini’s pathname is relative, provide the appropriate working_directory in Unit configuration.

Change ownership:

Run the following command (as root) so Unit can access the application directory (If the application uses several directories, run the command for each one):
console
# chown -R unit:unit /path/to/app/ # User and group that Unit's router runs as by default
```
# chown -R unit:unit /path/to/app/  # User and group that Unit's router runs as by default
   
```
The unit:unit user-group pair is available only with official packages , Docker images, and some third-party repos. Otherwise, account names may differ; run the ps aux | grep unitd command to be sure.

For further details, including permissions, see the security checklist.

Next, prepare the Pyramid configuration for Unit (use real values for type, home, and path):

{
   "listeners": {
      "*:80": {
         "pass": "applications/pyramid"
      }
   },
   "applications": {
      "pyramid": {
         "type": "python 3.Y",
         "type_comment": "Must match language module version and virtual environment version",
         "working_directory": "/path/to/app/",
         "working_directory_comment": "Path to the application directory; use a real path in your configuration",
         "path": "/path/to/app/",
         "path_comment": "Path to the application directory; use a real path in your configuration",
         "home": "/path/to/app/venv/",
         "home_comment": "Path to the virtual environment, if any",
         "module": "wsgi",
         "module_comment": "WSGI module filename with extension omitted",
         "callable": "app",
         "callable_comment": "Name of the callable in the module to run"
      }
   }
}

Upload the updated configuration.

Assuming the JSON above was added to config.json. Run the following command as root:

# curl -X PUT --data-binary @config.json --unix-socket \
      /path/to/control.unit.sock \  # Path to Unit's control socket in your installation
      http://localhost/config/      # Path to the config section in Unit's control API
   

The control socket path may vary; run unitd -h or see Startup and shutdown for details.

After a successful update, your app should be available on the listener’s IP address and port:

$ curl http://localhost

      <body><h1>Hello, World!</h1></body>

Last modified February 6, 2025