Skip to main content

Quill SDK for Python.

Project description

Quill Python SDK

Quickstart

First, install the quillsql package by running:

$ pip install quillsql

Then, add a /quill endpoint to your existing python server. For example, if you were running a FASTAPI app, you would just add the endpoint like this:

from quillsql import Quill
from fastapi import FastAPI, Request

app = FastAPI()

quill = Quill(
    private_key=<YOUR_PRIVATE_KEY_HERE>,
    database_connection_string=<YOUR_DB_CONNECTION_STRING_HERE>,
)

# ... your existing endpoints here ...

@app.post("/quill")
async def quill_post(data: Request):
    body = await data.json()
    return quill.query(org_id="2", data=body)

Then you can run your app like normally. Pass in this route to our react library on the frontend and you all set!

For local testing (dev purposes only)

pipenv install
pipenv shell
uvicorn examples.fastapi-server.app:app --reload --port 3000

You are now ready to ping your local server at http://localhost:3000.

Troubleshooting

If you run into issues with Library not loaded: @rpath/libpq.5.dylib or no LC_RPATH's found, try uninstalling and reinstalling postgres on your machine. For example, using homebrew:

$ brew uninstall postgresql
$ brew update
$ brew install postgresql

If you're still having this issue, this resource might also be useful for you: https://www.psycopg.org/docs/install.html.

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

quillsql-2.0.7.tar.gz (4.9 kB view details)

Uploaded Source

Built Distribution

quillsql-2.0.7-py3-none-any.whl (9.8 kB view details)

Uploaded Python 3

File details

Details for the file quillsql-2.0.7.tar.gz.

File metadata

  • Download URL: quillsql-2.0.7.tar.gz
  • Upload date:
  • Size: 4.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.6

File hashes

Hashes for quillsql-2.0.7.tar.gz
Algorithm Hash digest
SHA256 50f05cea8ccc30fe7ebd7505d485ece9bee8243919d6f4640ef880ffa9d7807e
MD5 92f87cfefa7fb2fa0ba7f9f6ead9c5a1
BLAKE2b-256 79531cc463811a0c29ae05478f03f2a11bee1a491631c59590eb7f5d7709571d

See more details on using hashes here.

File details

Details for the file quillsql-2.0.7-py3-none-any.whl.

File metadata

  • Download URL: quillsql-2.0.7-py3-none-any.whl
  • Upload date:
  • Size: 9.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.6

File hashes

Hashes for quillsql-2.0.7-py3-none-any.whl
Algorithm Hash digest
SHA256 f399386e451998d4eae4eb2c536d543c087c7326415a6e41130f3a4d6dc83b5f
MD5 fe7842d6de4388c974284a5c3bf5c8f2
BLAKE2b-256 8823cb163528f4be26316dc82bfa71d1f003af9c7ef2b659da0b8e4e8c3d5001

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