Skip to main content

Quart-DB is a Quart extension that provides managed connection(s) to database(s).

Project description

Build Status docs pypi python license

Quart-DB is a Quart extension that provides managed connection(s) to postgresql or sqlite database(s).

Quickstart

Quart-DB is used by associating it with an app and a DB (via a URL) and then utilising the g.connection connection,

from quart import g, Quart, websocket
from quart_db import QuartDB

app = Quart(__name__)
db = QuartDB(app, url="postgresql://user:pass@localhost:5432/db_name")

@app.get("/<int:id>")
async def get_count(id: int):
    result = await g.connection.fetch_val(
        "SELECT COUNT(*) FROM tbl WHERE id = :id",
        {"id": id},
    )
    return {"count": result}

@app.post("/")
async def set_with_transaction():
    async with g.connection.transaction():
        await db.execute("UPDATE tbl SET done = :done", {"done": True})
        ...
    return {}

@app.get("/explicit")
async def explicit_usage():
     async with db.connection() as connection:
         ...

Contributing

Quart-DB is developed on GitHub. If you come across an issue, or have a feature request please open an issue. If you want to contribute a fix or the feature-implementation please do (typo fixes welcome), by proposing a merge request.

Testing

The best way to test Quart-DB is with Tox,

$ pip install tox
$ tox

this will check the code style and run the tests.

Help

The Quart-DB documentation is the best places to start, after that try searching stack overflow or ask for help on gitter. If you still can’t find an answer please open an issue.

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

quart_db-0.8.1.tar.gz (11.5 kB view details)

Uploaded Source

Built Distribution

quart_db-0.8.1-py3-none-any.whl (13.2 kB view details)

Uploaded Python 3

File details

Details for the file quart_db-0.8.1.tar.gz.

File metadata

  • Download URL: quart_db-0.8.1.tar.gz
  • Upload date:
  • Size: 11.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/4.0.2 CPython/3.11.8

File hashes

Hashes for quart_db-0.8.1.tar.gz
Algorithm Hash digest
SHA256 d45ed09439125d18b9c389d945d0d2ceec182e53b79a13ad6b2c7dc0fe662b5c
MD5 6262d444a77705015803850c7bb0d36d
BLAKE2b-256 f7542b420a7b8d0e6c34de83ebf6d4b25cffe4eeec0dbd88d4b1e9f744aa210c

See more details on using hashes here.

File details

Details for the file quart_db-0.8.1-py3-none-any.whl.

File metadata

  • Download URL: quart_db-0.8.1-py3-none-any.whl
  • Upload date:
  • Size: 13.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/4.0.2 CPython/3.11.8

File hashes

Hashes for quart_db-0.8.1-py3-none-any.whl
Algorithm Hash digest
SHA256 93cc31403f85efd955ea9ecdb3ae10541e5bcefd31d52ca85e9d35101bdd378d
MD5 c8d3ac851a05001fc7a9c416e44b8e4b
BLAKE2b-256 43e4715086cde600444c3acc3f27605bad1d0c805170e591c28603b1b171cdd4

See more details on using hashes here.

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