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

Uploaded Source

Built Distribution

quart_db-0.6.1-py3-none-any.whl (12.5 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for quart_db-0.6.1.tar.gz
Algorithm Hash digest
SHA256 44097aeba529b3c74dc492f2d4e07957159a780d1fc40eab2ea37c12c1298bcc
MD5 c7b71eceb6342c7c43d3fc565449a7ef
BLAKE2b-256 ea54c8b9a8318efa523df29eb813f76844f0c548504eeadd22b6aa2ef889fea6

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for quart_db-0.6.1-py3-none-any.whl
Algorithm Hash digest
SHA256 aeaf19f780b1946af07aa6a44b4d9055d54ba12a0e02de1a023cf324091e5cd5
MD5 899adf9695b80f56c25b84fa30f178a5
BLAKE2b-256 f6ed9981102a90e0fedffb32d3cfbfb598a929fabd0f411837b54f387abd77a4

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