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

Uploaded Source

Built Distribution

quart_db-0.6.2-py3-none-any.whl (12.6 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for quart_db-0.6.2.tar.gz
Algorithm Hash digest
SHA256 1e0b23adb72091cff59b7a6008d36f0b4134412beb71f677f0552d9c2e38b1cb
MD5 ffa9c7067bcc6d14950fe72ec8b8e8c7
BLAKE2b-256 a1fe61f264535e9b714735f84d7bfcae5abb94e9e1b1013c8c14c4242c22c1ab

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for quart_db-0.6.2-py3-none-any.whl
Algorithm Hash digest
SHA256 05a3474928cf3a7d14ed9cd19817fc1e4d72cfed16b7b7cb29853dd631021062
MD5 9970a49c7bb2dda3263867cab8ac9712
BLAKE2b-256 803ec06052bb1317a8e037ebf7aeb281d1df327a661ecdea03b0ac239fd374b0

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