querykey-cases 0.1.0__tar.gz

querykey_cases-0.1.0/PKG-INFO

@@ -0,0 +1,61 @@
+Metadata-Version: 2.4
+Name: querykey-cases
+Version: 0.1.0
+Summary: Python client for QueryKey Cases HTTP API
+Author: QueryKey Cases Engineering
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://querykey.com/developers/
+Project-URL: Documentation, https://querykey.com/developers/
+Project-URL: Repository, https://github.com/RellWilson/querykey-cases
+Project-URL: Issues, https://github.com/RellWilson/querykey-cases/issues
+Keywords: querykey,cases,api,sdk,troubleshooting
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+Provides-Extra: dev
+Requires-Dist: pytest; extra == "dev"
+Provides-Extra: publish
+Requires-Dist: build; extra == "publish"
+Requires-Dist: twine; extra == "publish"
+
+# querykey-cases (Python)
+
+```bash
+pip install querykey-cases
+```
+
+```python
+from querykey_cases import QueryKeyClient
+
+client = QueryKeyClient(base_url="https://api.querykey.com")
+print(client.search_cases(q="TypeError", limit=5))
+```
+
+Environment: `QKEY_API_BASE`, `QKEY_API_KEY`.
+
+Local development:
+
+```bash
+pip install -e ./packages/querykey-cases-py
+```
+
+Release workflow:
+
+```bash
+python3 -m pip install --upgrade build twine
+python3 -m build
+python3 -m twine check dist/*
+python3 -m twine upload dist/*
+```
+
+Notes:
+
+- Python 3.10+
+- `timeout_seconds` defaults to `10`
+- `QueryKeyError` includes HTTP status and parsed error payload when available

querykey_cases-0.1.0/README.md

@@ -0,0 +1,35 @@
+# querykey-cases (Python)
+
+```bash
+pip install querykey-cases
+```
+
+```python
+from querykey_cases import QueryKeyClient
+
+client = QueryKeyClient(base_url="https://api.querykey.com")
+print(client.search_cases(q="TypeError", limit=5))
+```
+
+Environment: `QKEY_API_BASE`, `QKEY_API_KEY`.
+
+Local development:
+
+```bash
+pip install -e ./packages/querykey-cases-py
+```
+
+Release workflow:
+
+```bash
+python3 -m pip install --upgrade build twine
+python3 -m build
+python3 -m twine check dist/*
+python3 -m twine upload dist/*
+```
+
+Notes:
+
+- Python 3.10+
+- `timeout_seconds` defaults to `10`
+- `QueryKeyError` includes HTTP status and parsed error payload when available

querykey_cases-0.1.0/pyproject.toml

@@ -0,0 +1,38 @@
+[project]
+name = "querykey-cases"
+version = "0.1.0"
+description = "Python client for QueryKey Cases HTTP API"
+readme = "README.md"
+requires-python = ">=3.10"
+license = "Apache-2.0"
+authors = [
+  { name = "QueryKey Cases Engineering" }
+]
+keywords = ["querykey", "cases", "api", "sdk", "troubleshooting"]
+classifiers = [
+  "Development Status :: 3 - Alpha",
+  "Intended Audience :: Developers",
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Topic :: Software Development :: Libraries :: Python Modules"
+]
+
+[project.urls]
+Homepage = "https://querykey.com/developers/"
+Documentation = "https://querykey.com/developers/"
+Repository = "https://github.com/RellWilson/querykey-cases"
+Issues = "https://github.com/RellWilson/querykey-cases/issues"
+
+[project.optional-dependencies]
+dev = ["pytest"]
+publish = ["build", "twine"]
+
+[build-system]
+requires = ["setuptools>=68"]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools.packages.find]
+where = ["."]
+include = ["querykey_cases*"]

querykey_cases-0.1.0/querykey_cases/__init__.py

@@ -0,0 +1,3 @@
+from querykey_cases.client import QueryKeyClient, QueryKeyError
+
+__all__ = ["QueryKeyClient", "QueryKeyError"]

querykey_cases-0.1.0/querykey_cases/client.py

@@ -0,0 +1,86 @@
+from __future__ import annotations
+
+import json
+import os
+import urllib.error
+import urllib.parse
+import urllib.request
+from typing import Any, Mapping, MutableMapping, Optional
+
+DEFAULT_BASE_URL = "https://api.querykey.com"
+DEFAULT_TIMEOUT_SECONDS = 10
+
+
+class QueryKeyError(RuntimeError):
+    def __init__(self, message: str, *, status: Optional[int] = None, data: Any = None) -> None:
+        super().__init__(message)
+        self.status = status
+        self.data = data
+
+
+def _require_non_empty(value: str, field_name: str) -> str:
+    normalized = str(value or "").strip()
+    if not normalized:
+        raise ValueError(f"{field_name} must be a non-empty string.")
+    return normalized
+
+
+def _require_positive_int(value: int, field_name: str) -> int:
+    normalized = int(value)
+    if normalized <= 0:
+        raise ValueError(f"{field_name} must be a positive integer.")
+    return normalized
+
+
+class QueryKeyClient:
+    def __init__(
+        self,
+        base_url: Optional[str] = None,
+        api_key: Optional[str] = None,
+        timeout_seconds: int = DEFAULT_TIMEOUT_SECONDS,
+    ) -> None:
+        self.base_url = (base_url or os.environ.get("QKEY_API_BASE") or DEFAULT_BASE_URL).rstrip("/")
+        self.api_key = api_key or os.environ.get("QKEY_API_KEY") or ""
+        self.timeout_seconds = _require_positive_int(timeout_seconds, "timeout_seconds")
+
+    def _request(
+        self,
+        method: str,
+        path: str,
+        body: Optional[Mapping[str, Any]] = None,
+    ) -> Any:
+        url = f"{self.base_url}{path}"
+        headers: MutableMapping[str, str] = {"Accept": "application/json"}
+        if self.api_key:
+            headers["Authorization"] = f"Bearer {self.api_key}"
+        data: Optional[bytes] = None
+        if body is not None:
+            headers["Content-Type"] = "application/json"
+            data = json.dumps(body).encode("utf-8")
+        req = urllib.request.Request(url, data=data, headers=headers, method=method)
+        try:
+            with urllib.request.urlopen(req, timeout=self.timeout_seconds) as resp:
+                raw = resp.read().decode("utf-8")
+                return json.loads(raw) if raw else {}
+        except urllib.error.HTTPError as e:
+            payload = e.read().decode("utf-8")
+            try:
+                detail = json.loads(payload)
+            except json.JSONDecodeError:
+                detail = {"message": payload or str(e)}
+            raise QueryKeyError(detail.get("message", str(e)), status=e.code, data=detail) from e
+        except urllib.error.URLError as e:
+            raise QueryKeyError(str(e.reason) or str(e)) from e
+
+    def search_cases(self, q: str = "", limit: int = 5, page: int = 1) -> Any:
+        limit_value = _require_positive_int(limit, "limit")
+        page_value = _require_positive_int(page, "page")
+        qs = urllib.parse.urlencode({"q": q, "limit": limit_value, "page": page_value})
+        return self._request("GET", f"/api/v1/cases?{qs}")
+
+    def get_case(self, case_id: str) -> Any:
+        enc = urllib.parse.quote(_require_non_empty(case_id, "case_id"), safe="")
+        return self._request("GET", f"/api/v1/cases/{enc}")
+
+    def bootstrap_start(self) -> Any:
+        return self._request("POST", "/api/v1/bootstrap/start")

querykey_cases-0.1.0/querykey_cases.egg-info/PKG-INFO

@@ -0,0 +1,61 @@
+Metadata-Version: 2.4
+Name: querykey-cases
+Version: 0.1.0
+Summary: Python client for QueryKey Cases HTTP API
+Author: QueryKey Cases Engineering
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://querykey.com/developers/
+Project-URL: Documentation, https://querykey.com/developers/
+Project-URL: Repository, https://github.com/RellWilson/querykey-cases
+Project-URL: Issues, https://github.com/RellWilson/querykey-cases/issues
+Keywords: querykey,cases,api,sdk,troubleshooting
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+Provides-Extra: dev
+Requires-Dist: pytest; extra == "dev"
+Provides-Extra: publish
+Requires-Dist: build; extra == "publish"
+Requires-Dist: twine; extra == "publish"
+
+# querykey-cases (Python)
+
+```bash
+pip install querykey-cases
+```
+
+```python
+from querykey_cases import QueryKeyClient
+
+client = QueryKeyClient(base_url="https://api.querykey.com")
+print(client.search_cases(q="TypeError", limit=5))
+```
+
+Environment: `QKEY_API_BASE`, `QKEY_API_KEY`.
+
+Local development:
+
+```bash
+pip install -e ./packages/querykey-cases-py
+```
+
+Release workflow:
+
+```bash
+python3 -m pip install --upgrade build twine
+python3 -m build
+python3 -m twine check dist/*
+python3 -m twine upload dist/*
+```
+
+Notes:
+
+- Python 3.10+
+- `timeout_seconds` defaults to `10`
+- `QueryKeyError` includes HTTP status and parsed error payload when available

querykey_cases-0.1.0/querykey_cases.egg-info/SOURCES.txt

@@ -0,0 +1,9 @@
+README.md
+pyproject.toml
+querykey_cases/__init__.py
+querykey_cases/client.py
+querykey_cases.egg-info/PKG-INFO
+querykey_cases.egg-info/SOURCES.txt
+querykey_cases.egg-info/dependency_links.txt
+querykey_cases.egg-info/requires.txt
+querykey_cases.egg-info/top_level.txt

querykey_cases-0.1.0/querykey_cases.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

querykey_cases-0.1.0/querykey_cases.egg-info/requires.txt

@@ -0,0 +1,7 @@
+
+[dev]
+pytest
+
+[publish]
+build
+twine

querykey_cases-0.1.0/querykey_cases.egg-info/top_level.txt

@@ -0,0 +1 @@
+querykey_cases

querykey_cases-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+