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

Uploaded Source

Built Distribution

quart_db-0.7.1-py3-none-any.whl (12.7 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for quart_db-0.7.1.tar.gz
Algorithm Hash digest
SHA256 d2a1b8fa5339c5b5ec9ba637f391eb9d8ee0c711f5402c8d43be7accc7d58910
MD5 3c60d7eace555708ad46cc6cad09b738
BLAKE2b-256 34e4b9c2d639330d8b88d62a933b616723836067b58ef6037a08ea5e510701cb

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for quart_db-0.7.1-py3-none-any.whl
Algorithm Hash digest
SHA256 9a4b2049f802cbe59c931206af6b446626d22c71067cdd68010cb150b6010dbd
MD5 b2f3f1c2cdfc2a078de5089b649b62a0
BLAKE2b-256 b6becd08deeffa48eed00972472e58441adc8e72d1851776ab87f42a73b55d3b

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