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.2.tar.gz (11.5 kB view details)

Uploaded Source

Built Distribution

quart_db-0.8.2-py3-none-any.whl (13.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: quart_db-0.8.2.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.2.tar.gz
Algorithm Hash digest
SHA256 1b12d4a8eeb11ba929c8f5e4e13e2319faf31ca29ae5720fc15fb4993abbc8d8
MD5 94f070aa585d1fe98a8cf326cf942b76
BLAKE2b-256 30db5294bc61a973a607d4cefaccd37f8a3000b0641ed0787f81f796f4a9e83d

See more details on using hashes here.

File details

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

File metadata

  • Download URL: quart_db-0.8.2-py3-none-any.whl
  • Upload date:
  • Size: 13.3 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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 f861bdebda2eeceae3736532d80000fec1ac78d06dc116968ce2b221d2be687d
MD5 e2cc167de4a7eb1d73980ae760e83312
BLAKE2b-256 54a3232834fbb732c7f011a0faaa30a0793ed5d325cbd64e9288c95276acc21a

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