plaster-pastedeploy Registry Entry

1.0.1 · active · verified Sat Apr 11

Plaster-pastedeploy provides a `plaster` loader that understands `PasteDeploy` configuration files, primarily used for loading WSGI applications and server configurations from INI-style files. It is currently at version 1.0.1. Its release cadence is generally stable and aligns with major `plaster` and `PasteDeploy` releases.

Warnings

gotcha For plaster-pastedeploy's loader to be available to `plaster.parse_uri`, `import plaster_pastedeploy` must be executed *before* `plaster.parse_uri` is called. This ensures the entry points are loaded and the PasteDeploy loader is registered.
Fix: Ensure `import plaster_pastedeploy` is placed at the top of your module or prior to any `plaster.parse_uri` calls.
gotcha PasteDeploy configurations often use `egg:package#factory` syntax for specifying applications and servers. These rely on `setuptools` entry points and the referenced packages being installed in your Python environment. If packages like `webtest-app` or `waitress` (common in examples) are not installed, `plaster-pastedeploy` will raise `DistributionNotFound` or similar errors during configuration loading.
Fix: Ensure all packages referenced in your `use = egg:spec` directives within the .ini file are installed in your environment (e.g., `pip install webtest-app waitress`).
breaking `plaster-pastedeploy` v1.x is designed to work with `plaster` v1.x. `plaster` itself introduced significant breaking changes between its 0.x and 1.x versions (e.g., `plaster.PlasterLoader` was removed). Attempting to use `plaster-pastedeploy` 1.x with `plaster` 0.x, or an older `plaster-pastedeploy` with `plaster` 1.x, will lead to API incompatibilities and runtime errors.
Fix: When upgrading, ensure both `plaster` and `plaster-pastedeploy` are at compatible 1.x versions (e.g., `pip install 'plaster>=1.0' 'plaster-pastedeploy>=1.0'`). Review `plaster`'s migration guide if moving from 0.x.

Install

pip install plaster-pastedeploy Install plaster-pastedeploy

Imports

plaster_pastedeploy
```
import plaster_pastedeploy
```
Importing the package registers its PasteDeploy loader with the plaster ecosystem.
parse_uri
```
from plaster import parse_uri
```
The primary way to use plaster-pastedeploy's functionality is through plaster's parse_uri after importing plaster_pastedeploy.

Quickstart

This quickstart demonstrates how to use `plaster-pastedeploy` to load a WSGI application and server configuration from a `PasteDeploy`-style `.ini` file using the `plaster` API. Importing `plaster_pastedeploy` ensures that `plaster` can correctly parse URIs starting with `config:` that point to `PasteDeploy` configurations. For this example to fully run without errors regarding egg specs, `webtest-app` and `waitress` would need to be installed.

import os
import plaster
import plaster_pastedeploy # This registers the PasteDeploy loader

# Create a dummy PasteDeploy-style config file
config_content = """
[app:main]
use = egg:webtest_app#main

[server:main]
use = egg:waitress#main
host = 127.0.0.1
port = 8080
"""
config_path = "development.ini"
with open(config_path, "w") as f:
    f.write(config_content)

# Parse the URI using plaster (which now knows about PasteDeploy thanks to plaster_pastedeploy)
# Note: webtest_app and waitress would need to be installed for a real application.
try:
    loader = plaster.parse_uri(f"config:{config_path}")
    print(f"Successfully parsed configuration using loader: {type(loader).__name__}")

    # Example: Get a WSGI application
    app = loader.get_wsgi_app("main")
    print(f"WSGI App loaded: {app}")

    # Example: Get a WSGI server factory
    server_factory = loader.get_wsgi_server("main")
    print(f"WSGI Server factory loaded: {server_factory}")

except Exception as e:
    print(f"An error occurred: {e}")
finally:
    # Clean up the dummy config file
    if os.path.exists(config_path):
        os.remove(config_path)

view raw JSON →