litestar-asyncpg

Litestar Logo - Light Litestar Logo - Dark

Project		Status
CI/CD
Quality
Package
Community
Meta

# Litestar Asyncpg

A barebones AsyncPG plugin for Litestar. This plugin is useful for when you plan to use no ORM or need to manage the postgres connection separately.

Usage

Installation

pip install litestar-asyncpg

Example

Here is a basic application that demonstrates how to use the plugin.

from __future__ import annotations

from typing import TYPE_CHECKING

from litestar import Controller, Litestar, get
from litestar_asyncpg import AsyncpgConfig, AsyncpgPlugin, PoolConfig

if TYPE_CHECKING:
    from asyncpg import Connection


class SampleController(Controller):
    @get(path="/sample")
    async def sample_route(self, db_connection: Connection) -> dict[str, str]:
        """Check database available and returns app config info."""
        result = await db_connection.fetch("select 1")
        return {"select_1": str(result)}


asyncpg = AsyncpgPlugin(config=AsyncpgConfig(pool_config=PoolConfig(dsn="postgresql://app:app@localhost:5432/app")))
app = Litestar(plugins=[asyncpg], route_handlers=[SampleController])

Download files

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

Source Distribution

litestar_asyncpg-0.3.0.tar.gz (66.8 kB view details)

Uploaded Nov 26, 2024 Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

litestar_asyncpg-0.3.0-py3-none-any.whl (9.5 kB view details)

Uploaded Nov 26, 2024 Python 3

File details

Details for the file litestar_asyncpg-0.3.0.tar.gz.

File metadata

Download URL: litestar_asyncpg-0.3.0.tar.gz
Upload date: Nov 26, 2024
Size: 66.8 kB
Tags: Source
Uploaded using Trusted Publishing? Yes
Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for litestar_asyncpg-0.3.0.tar.gz
Algorithm	Hash digest
SHA256	`29cb9cb02ccd1fee1b12968a3224354b79346233c8b2fae6ee4f6ef869ddee0f`
MD5	`cd9c304074f9d7e2df5489f2ed06b28f`
BLAKE2b-256	`4f408e163a87b6cd1d7886d2d5b3d6e2b627478cee66b66b413ad05292e44e6e`

See more details on using hashes here.

Provenance

The following attestation bundles were made for litestar_asyncpg-0.3.0.tar.gz:

Publisher: publish.yaml on litestar-org/litestar-asyncpg

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Statement:
- Statement type: https://in-toto.io/Statement/v1
- Predicate type: https://docs.pypi.org/attestations/publish/v1
- Subject name: litestar_asyncpg-0.3.0.tar.gz
- Subject digest: 29cb9cb02ccd1fee1b12968a3224354b79346233c8b2fae6ee4f6ef869ddee0f
- Sigstore transparency entry: 151805957
- Sigstore integration time: Nov 26, 2024
Source repository:
- Permalink: litestar-org/litestar-asyncpg@23ab40d9fdcdc228044e17acab5f2977da67654d
- Branch / Tag: refs/heads/main
- Owner: https://github.com/litestar-org
- Access: public
Publication detail:
- Token Issuer: https://token.actions.githubusercontent.com
- Runner Environment: github-hosted
- Publication workflow: publish.yaml@23ab40d9fdcdc228044e17acab5f2977da67654d
- Trigger Event: workflow_dispatch