quillsql 2.0__py3-none-any.whl → 2.0.1__py3-none-any.whl

quillsql/core.py

@@ -1,14 +1,18 @@
+import os
+import json
+
 import requests
 import psycopg2
-import psycopg2.extras
-import json
 import redis
 
 from psycopg2.extensions import make_dsn
 
+
 ## The host url of the Quill metadata server
-HOST = "https://quill-344421.uc.r.appspot.com"  # or "http://localhost:8080"
-# HOST = "http://localhost:8080"
+ENV = os.environ.get("PYTHON_ENV")
+DEV_HOST = "http://localhost:8080"
+PROD_HOST = "https://quill-344421.uc.r.appspot.com"
+HOST = DEV_HOST if ENV == "development" else PROD_HOST
 
 
 ## The TTL for new cache entries (default: 1h)
@@ -24,7 +28,7 @@ class CachedPool:
             self.pool = psycopg2.connect(config)
         self.cache = self.get_cache(cache_config)
         self.ttl = cache_config and cache_config.get("ttl") or DEFAULT_CACHE_TTL
-        self.cur = self.pool.cursor(cursor_factory=psycopg2.extras.RealDictCursor)
+        self.cur = self.pool.cursor()
         self.orgId = None
 
     def get_cache(self, cache_config):
@@ -44,7 +48,7 @@ class CachedPool:
     def exec(self, sql):
         self.cur.execute(sql)
         rows = self.cur.fetchall()
-        return [json.loads(json.dumps(row, default=str)) for row in rows]
+        return [self._build_dict(self.cur, row) for row in rows]
 
     def query(self, sql):
         if not self.cache:
@@ -59,6 +63,13 @@ class CachedPool:
             new_result_string = json.dumps(new_result)
             self.cache.set(key, new_result_string, "EX", DEFAULT_CACHE_TTL)
             return new_result
+    
+    # Parses the row from a tuple to a dict using the cursor description.
+    def _build_dict(self, cursor, row):
+        dict_row = {}
+        for key, col in enumerate(cursor.description):
+            dict_row[col[0]] = row[key]
+        return json.loads(json.dumps(dict_row, default=str))
 
 
 ## handles a query task

quillsql-2.0.1.dist-info/METADATA

@@ -0,0 +1,54 @@
+Metadata-Version: 2.1
+Name: quillsql
+Version: 2.0.1
+Summary: Quill SDK for Python.
+Home-page: https://github.com/quill-sql/quill-python
+Author: Quill
+Author-email: shawn@quillsql.com
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: psycopg2-binary
+Requires-Dist: requests
+Requires-Dist: redis
+Requires-Dist: python-dotenv
+Requires-Dist: pytest
+
+# Quill Python SDK
+[![Quill SDK](https://github.com/quill-sql/quill-python/actions/workflows/ci.yaml/badge.svg?branch=main)](https://github.com/quill-sql/quill-python/actions/workflows/ci.yaml)
+
+## Quickstart
+
+First, install the quillsql package by running:
+
+```bash
+$ 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:
+
+```python
+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!
+
+
+## Questions
+If you have any questions, please reach out to us!

quillsql-2.0.1.dist-info/RECORD

@@ -0,0 +1,11 @@
+quillsql/__init__.py,sha256=IgJnPRLx5GcenVt82mMQo0ydvXYB_-39Ft4Of5sEEGA,39
+quillsql/core.py,sha256=WkVwPfbhH_b3mdWGP3rYRNk1wFAVOo8DFlJwnrlLozA,12428
+tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+tests/cache_test.py,sha256=5MvAAyGF37wiRejOwG8m4uG9jxnEOseV5GtXTtjAk-8,11092
+tests/external_test.py,sha256=pTHIiWMA0JFTapdHzoNR7ud1uCXw1r8P0kBbVLWxaXk,7466
+tests/simple_test.py,sha256=DTGOFHvljEJs6akVIrDwLr9shYIP68t7-JrF_d17O2Y,7378
+quillsql-2.0.1.dist-info/LICENSE,sha256=f2-T2fNvArbqfNW8RwsOu2IWEwpsaRX6G-AJvLJKuzg,1068
+quillsql-2.0.1.dist-info/METADATA,sha256=IeQgdsc33ygynQnGt75syOXbxIAtkSjtmmbMAtctYzA,1395
+quillsql-2.0.1.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
+quillsql-2.0.1.dist-info/top_level.txt,sha256=DCsUgdO5twxI1s5sw-euqMt1NDDtIGMR-t9A68P3gZs,15
+quillsql-2.0.1.dist-info/RECORD,,

{quillsql-2.0.dist-info → quillsql-2.0.1.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: bdist_wheel (0.41.2)
+Generator: bdist_wheel (0.42.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

quillsql-2.0.dist-info/METADATA

@@ -1,35 +0,0 @@
-Metadata-Version: 2.1
-Name: quillsql
-Version: 2.0
-Summary: Quill SDK for Python.
-Home-page: https://github.com/quill-sql/quill-python
-Author: Quill
-Author-email: shawn@quillsql.com
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: psycopg2-binary
-Requires-Dist: requests
-Requires-Dist: redis
-Requires-Dist: python-dotenv
-Requires-Dist: pytest
-
-Quill SDK for Python
-
-
-## Quickstart
-
-Install dependencies
-```bash
-$ pip install .
-```
-
-Run unit tests
-```bash
-$ pytest
-```
-
-## Troubleshooting
-
-```
-$ python3 -m pip install --upgrade setuptools
-```

quillsql-2.0.dist-info/RECORD

@@ -1,12 +0,0 @@
-quillsql/__init__.py,sha256=IgJnPRLx5GcenVt82mMQo0ydvXYB_-39Ft4Of5sEEGA,39
-quillsql/core.py,sha256=dl6ry6_C6NUZKlU4gVaneD8zwEvdndcYLTEn_XgaDQk,12129
-tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-tests/cache_test.py,sha256=5MvAAyGF37wiRejOwG8m4uG9jxnEOseV5GtXTtjAk-8,11092
-tests/external_test.py,sha256=pTHIiWMA0JFTapdHzoNR7ud1uCXw1r8P0kBbVLWxaXk,7466
-tests/simple_test.py,sha256=DTGOFHvljEJs6akVIrDwLr9shYIP68t7-JrF_d17O2Y,7378
-tests/staging_test.py,sha256=zdDV6BvJRyNKCy80bxDNfK1F1oqM6oIv7ul7JPKi51Q,4962
-quillsql-2.0.dist-info/LICENSE,sha256=f2-T2fNvArbqfNW8RwsOu2IWEwpsaRX6G-AJvLJKuzg,1068
-quillsql-2.0.dist-info/METADATA,sha256=Atl3xFsavnxO6DWo4BaeJTLo37rtHffvC4csuVldGFA,570
-quillsql-2.0.dist-info/WHEEL,sha256=yQN5g4mg4AybRjkgi-9yy4iQEFibGQmlz78Pik5Or-A,92
-quillsql-2.0.dist-info/top_level.txt,sha256=DCsUgdO5twxI1s5sw-euqMt1NDDtIGMR-t9A68P3gZs,15
-quillsql-2.0.dist-info/RECORD,,

tests/staging_test.py

@@ -1,168 +0,0 @@
-import pytest
-from quillsql import Quill
-import os
-from dotenv import load_dotenv
-
-load_dotenv()
-
-
-quill = Quill(
-    private_key=os.environ.get("QUILL_PRIVATE_KEY"),
-    database_connection_string=os.environ.get("POSTGRES_STAGING_READ"),
-)
-
-
-def test_config_gets_metadata():
-    res = quill.query(
-        org_id="2", data={"metadata": {"task": "config", "name": "spend"}}
-    )
-
-    assert res is not None
-    assert "sections" in res
-    assert "newQueries" in res
-    assert "filters" in res
-    assert res["filters"] == []
-    assert "fieldToRemove" in res
-    assert res["fieldToRemove"] == "customer_id"
-
-    for query in res["newQueries"]:
-        assert "columns" in query
-        assert any(
-            column["field"] == "spend"
-            and column["label"] == "spend"
-            and column["format"] == "dollar_amount"
-            for column in query["columns"]
-        )
-        assert any(
-            column["field"] == "month"
-            and column["label"] == "month"
-            and column["format"] == "MMM_yyyy"
-            for column in query["columns"]
-        )
-
-
-def test_handles_empty_client_id():
-    res = quill.query(
-        org_id="2",
-        data={
-            "metadata": {
-                "task": "item",
-                "id": "6580d3aea2caa9000b1c1b06",
-                "client_id": None,
-                "filters": [],
-                "query": "select * from transactions",
-            }
-        },
-    )
-
-    assert res["chartType"] == "line"
-    assert res["clientId"] == "62cda15d7c9fcca7bc0a3689"
-    assert res["name"] == "Total Spend Test"
-    assert res["dashboardName"] == "spend"
-
-
-def test_gets_item():
-    res = quill.query(
-        org_id="2",
-        data={
-            "metadata": {
-                "task": "item",
-                "id": "6580d3aea2caa9000b1c1b06",
-                "client_id": "62cda15d7c9fcca7bc0a3689",
-                "filters": [],
-                "query": "select * from transactions",
-            }
-        },
-    )
-
-    assert res["chartType"] == "line"
-    assert res["clientId"] == "62cda15d7c9fcca7bc0a3689"
-    assert res["name"] == "Total Spend Test"
-    assert res["dashboardName"] == "spend"
-
-
-def test_query_for_data():
-    res = quill.query(
-        org_id="2",
-        data={
-            "metadata": {
-                "task": "query",
-                "id": "6580d48f457d7b000b7bee2c",
-                "query": "select sum(amount) as spend, date_trunc('month', created_at) as month from transactions group by month order by max(created_at);",
-            }
-        },
-    )
-
-    assert "rows" in res
-    assert "fields" in res
-
-
-def test_creates_a_chart():
-    res = quill.query(
-        org_id="2",
-        data={
-            "metadata": {
-                "task": "create",
-                "dateField": {"table": "transactions", "field": "created_at"},
-                "query": "select sum(amount) as spend, date_trunc('month', created_at) as month from transactions group by month order by max(created_at);",
-                "name": "Total Spend Test",
-                "clientId": "62cda15d7c9fcca7bc0a3689",
-                "customerId": "2",
-                "xAxisField": "month",
-                "xAxisLabel": "month",
-                "yAxisFields": [
-                    {"field": "spend", "label": "spend", "format": "dollar_amount"}
-                ],
-                "yAxisLabel": "spend",
-                "chartType": "line",
-                "dashboardName": "spend",
-                "xAxisFormat": "MMM_yyyy",
-                "columns": [
-                    {"field": "spend", "label": "spend", "format": "dollar_amount"},
-                    {"field": "month", "label": "month", "format": "MMM_yyyy"},
-                ],
-            }
-        },
-    )
-
-    assert res is not None
-
-
-def test_returns_different_configs_for_different_org_ids():
-    data = {
-        "metadata": {
-            "task": "config",
-            "name": "spend",
-        }
-    }
-    res1 = quill.query(org_id="1", data=data)
-    res2 = quill.query(org_id="2", data=data)
-    assert res1 != res2
-
-
-def test_returns_different_items_for_different_org_ids():
-    data = {
-        "metadata": {
-            "task": "item",
-            "id": "6580d3aea2caa9000b1c1b06",
-            "filters": [],
-            "client_id": "62cda15d7c9fcca7bc0a3689",
-            "query": "select * from transactions",
-        }
-    }
-    res1 = quill.query(org_id="1", data=data)
-    res2 = quill.query(org_id="2", data=data)
-    assert res1 != res2
-
-
-def test_returns_different_query_data_for_different_org_ids():
-    data = {
-        "metadata": {
-            "task": "query",
-            "id": "6580d48f457d7b000b7bee2c",
-            "query": "select sum(amount) as spend, date_trunc('month', created_at) as month from transactions group by month order by max(created_at);",
-        }
-    }
-    res1 = quill.query(org_id="1", data=data)
-    res2 = quill.query(org_id="2", data=data)
-    assert res1 != res2