Skip to main content

ASGI S3 storage

Project description

asgi-s3

Package version Build Status

Staticfile management tools and ASGI middleware support for Amazon S3.

Work in Progress: A lot of what is here currently will be changing.

CLI

s3 sync

...todo

Middleware

The middleware is designed to work with any ASGI application. Here is raw ASGI example:

from asgi_s3.middleware import S3StorageMiddleware

async def app(scope, receive, send):
    url_for = scope["asgi_s3"]["url_for"]
    await send(
        {
            "type": "http.response.start",
            "status": 200,
            "headers": [[b"content-type", b"text/html; charset=utf-8"]],
        }
    )
    html_content = f"""
    <!DOCTYPE html>
    <html>
    <head>
        <title>ASGI S3 example</title>
        <link rel="stylesheet" href="{url_for('style.css')}">
    </head>
    <body>
    Hello, world.
    </body>
    </html>
    """
    await send({"type": "http.response.body", "body": html_content.encode()})


app = S3StorageMiddleware(
    app,
    bucket_name="my-bucket",
    static_dir="path/to/static/files",
)

And here is an example using Starlette:

from starlette.applications import Starlette
from starlette.templating import Jinja2Templates

from asgi_s3.middleware import S3StorageMiddleware

templates = Jinja2Templates("templates")
app = Starlette()

@app.route("/")
def homepage(request):
    s3_url_for = request.scope["asgi_s3"]["s3_url_for"]
    return templates.TemplateResponse(
        "index.html", {"request": request, "s3_url_for": s3_url_for}
    )


app.add_middleware(
    S3StorageMiddleware,
    bucket_name="my-bucket",
    static_dir="path/to/static/files",
)

Project details


Download files

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

Source Distribution

asgi-s3-0.0.1.tar.gz (4.5 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page