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

Uploaded Source

Built Distribution

quart_db-0.5.0-py3-none-any.whl (12.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: quart_db-0.5.0.tar.gz
  • Upload date:
  • Size: 10.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/4.0.1 CPython/3.11.3

File hashes

Hashes for quart_db-0.5.0.tar.gz
Algorithm Hash digest
SHA256 b7ad015a13320506cb9557d0b91dfc8080ff51708bbb9abce2c5c1961b9591c6
MD5 98e181ca22c7b4c28ab4a6a2b9d66c24
BLAKE2b-256 d346c650a002540020ec06727982bf75e6a46cabb26500fb3c57f1f7ec305ffd

See more details on using hashes here.

File details

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

File metadata

  • Download URL: quart_db-0.5.0-py3-none-any.whl
  • Upload date:
  • Size: 12.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/4.0.1 CPython/3.11.3

File hashes

Hashes for quart_db-0.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 4e516995020bcedec7aef6bf8bbe08ed39894bad9cb521cfae4b3c2557033dec
MD5 daa48e976e00014d630ea5c19aaa6be7
BLAKE2b-256 eb51c20103b8b89c62ac7262e7221bc62e5f9b636484196b97a5f9bd385bdf00

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