asgi-sqlalchemy

Name	asgi-sqlalchemy JSON
Version	0.1.0 JSON
	download
home_page	None
Summary	Pure ASGI Database middleware.
upload_time	2025-01-02 16:06:45
maintainer	None
docs_url	None
author	None
requires_python	>=3.10
license	None
keywords	fastapi middleware sqlalchemy asgi
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # asgi-sqlalchemy

ASGI Middleware that manages the lifespan of a database engine and a corresponding session.

## Usage:

### FastAPI:

```python
from contextlib import AsyncContextManager
from collections.abc import AsyncGenerator
from typing_extensions import TypedDict

from fastapi import FastAPI

from asgi_sqlalchemy import DatabaseContext, SessionMiddleware
from asgi_sqlalchemy.fastapi import SessionDependency

class AppState(TypedDict):
    db: DatabaseContext

async def lifespan() -> AsyncGenerator[AppState]:
    async with DatabaseContext(...) as db:
        yield {"db": db}

app = FastAPI()
app.add_middleware(SessionMiddleware)

@app.get("/db")
async def handler(session: SessionDependency) -> str:
    # do something with your async session!
```
            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "asgi-sqlalchemy",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.10",
    "maintainer_email": null,
    "keywords": "FastAPI, Middleware, SQLAlchemy, asgi",
    "author": null,
    "author_email": "Abhi Agarwal <abhiaagarwal01@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/93/82/126cb43158c42be456e50d8ff1d8ab9357cb4a2281b4983b33a8a6e0b7f8/asgi_sqlalchemy-0.1.0.tar.gz",
    "platform": null,
    "description": "# asgi-sqlalchemy\n\nASGI Middleware that manages the lifespan of a database engine and a corresponding session.\n\n## Usage:\n\n### FastAPI:\n\n```python\nfrom contextlib import AsyncContextManager\nfrom collections.abc import AsyncGenerator\nfrom typing_extensions import TypedDict\n\nfrom fastapi import FastAPI\n\nfrom asgi_sqlalchemy import DatabaseContext, SessionMiddleware\nfrom asgi_sqlalchemy.fastapi import SessionDependency\n\nclass AppState(TypedDict):\n    db: DatabaseContext\n\nasync def lifespan() -> AsyncGenerator[AppState]:\n    async with DatabaseContext(...) as db:\n        yield {\"db\": db}\n\napp = FastAPI()\napp.add_middleware(SessionMiddleware)\n\n@app.get(\"/db\")\nasync def handler(session: SessionDependency) -> str:\n    # do something with your async session!\n```",
    "bugtrack_url": null,
    "license": null,
    "summary": "Pure ASGI Database middleware.",
    "version": "0.1.0",
    "project_urls": {
        "homepage": "https://github.com/abhiaagarwal/asgi-sqlalchemy",
        "issues": "https://github.com/abhiaagarwal/asgi-sqlalchemy/issues",
        "repository": "https://github.com/abhiaagarwal/asgi-sqlalchemy"
    },
    "split_keywords": [
        "fastapi",
        " middleware",
        " sqlalchemy",
        " asgi"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "5a429181abff1bdfa0bc086a6bb45f3c54f04950d1eb2cafe109d339fe917929",
                "md5": "dcc3f47f2c8a3defc78480f00a13adf8",
                "sha256": "1c3d9a75a95ef98618b1274f241610c18f44dbd82c1dc150c7538f0264c09c1a"
            },
            "downloads": -1,
            "filename": "asgi_sqlalchemy-0.1.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "dcc3f47f2c8a3defc78480f00a13adf8",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.10",
            "size": 4938,
            "upload_time": "2025-01-02T16:06:41",
            "upload_time_iso_8601": "2025-01-02T16:06:41.313008Z",
            "url": "https://files.pythonhosted.org/packages/5a/42/9181abff1bdfa0bc086a6bb45f3c54f04950d1eb2cafe109d339fe917929/asgi_sqlalchemy-0.1.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "9382126cb43158c42be456e50d8ff1d8ab9357cb4a2281b4983b33a8a6e0b7f8",
                "md5": "b1e9bb19afe099a8f180a399e7288fba",
                "sha256": "29d50cd28f7033b41f9ae5a83a580f40c0f67b135652ecbc320e1d6dad7fb5b2"
            },
            "downloads": -1,
            "filename": "asgi_sqlalchemy-0.1.0.tar.gz",
            "has_sig": false,
            "md5_digest": "b1e9bb19afe099a8f180a399e7288fba",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.10",
            "size": 42671,
            "upload_time": "2025-01-02T16:06:45",
            "upload_time_iso_8601": "2025-01-02T16:06:45.819325Z",
            "url": "https://files.pythonhosted.org/packages/93/82/126cb43158c42be456e50d8ff1d8ab9357cb4a2281b4983b33a8a6e0b7f8/asgi_sqlalchemy-0.1.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-01-02 16:06:45",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "abhiaagarwal",
    "github_project": "asgi-sqlalchemy",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "asgi-sqlalchemy"
}