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

Uploaded Source

Built Distribution

quart_db-0.8.0-py3-none-any.whl (13.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: quart_db-0.8.0.tar.gz
  • Upload date:
  • Size: 11.4 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.0.tar.gz
Algorithm Hash digest
SHA256 dadbb90638ea822379312a910300e4771b7ffc994312c964bc5ed10b370dabb4
MD5 b22fb67c04e1244fb3427ba082f19ccf
BLAKE2b-256 5817d36e346248b834a7d439618dba41655f8bd9c80a864241ad5ecd3b9bdc4e

See more details on using hashes here.

File details

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

File metadata

  • Download URL: quart_db-0.8.0-py3-none-any.whl
  • Upload date:
  • Size: 13.1 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.0-py3-none-any.whl
Algorithm Hash digest
SHA256 2641d61ac3dd13952bb82b82f030ec899c18c762afc5ee58c3b944a80df20fcd
MD5 830ef9181759780a9806cc38279b4b9c
BLAKE2b-256 104602254e6366815cadf511aa08ab138105fdacb6129348a7748ec06793d909

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