Skip to main content

Create Starlette Plugins easier

Project description

starlette-plugins – A helper to make plugins faster with Starlette

Starlette-Plugins is a helper to write plugins easier

Tests Status PYPI Version

Requirements

  • python >= 3.7

Installation

starlette-plugins should be installed using pip:

pip install starlette-plugins

Usage

Let’s imagine that we need to write Starlette plugins for Peewee ORM.

from aiopeewee import db_url

from starlette_plugins import StarlettePlugin

class Peewee(StarlettePlugin):

    # Give your plugin a name
    name = 'db'

    # Prepare a default configuration
    config = {
        'url': 'sqlite+async:///db.sqlite',
        'connection_params': {},
    }

def __init__(self, app=None, **settings):
    super(Peewee, self).__init__(app, **settings)
    self.database = None

def setup(self, app, **settings):
    """Setup the plugin."""
    super(Peewee, self).setup(app, **settings)
    self.database = db_url.connect(self.config.url, **self.config.connection_params)

async def middleware(self, scope, receive, send, app):
    """An optional ASGI middleware."""
    try:
        await self.database.connect_async()
        await app(scope, receive, send)
    finally:
        await self.database.close_async()

async def shutdown(self, scope):
    """ The methods are supported: `startup`, `shutdown`."""
    if hasattr(self.database, 'close_all'):
        self.database.close_all()

Use the plugin

from starlette.applications import Starlette


db = Peewee(url='postgres+async://database')

app = Starlette()
db.setup(app)

Bug tracker

If you have any suggestions, bug reports or annoyances please report them to the issue tracker at https://github.com/klen/starlette-plugins/issues

Contributing

Development of the project happens at: https://github.com/klen/starlette-plugins

License

Licensed under a MIT license.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release. See tutorial on generating distribution archives.

Built Distribution

starlette_plugins-0.0.7-py3-none-any.whl (4.1 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page