ci: durably stamp package metadata in regen + fix README auth (#49)

* ci(regen): stamp gitUserId/gitRepoId and patch keywords post-generate

* docs: update README auth example for api_key/workspace_id and api host

* docs: add pypi install, drop generator mention, fix relative docs links

* docs: drop tests section and link Hotdata to www site

* docs: drop maintainer note from API reference section

* ci(regen): also patch [project.urls] to include Homepage

Author: zfarrell

.github/workflows/regenerate.yml

@@ -49,7 +49,7 @@ jobs:
             -g python \
             -o . \
             -t .openapi-generator-templates \
-            --additional-properties=packageName=hotdata,projectName=hotdata,packageVersion=${{ steps.pkg.outputs.version }} \
+            --additional-properties=packageName=hotdata,projectName=hotdata,packageVersion=${{ steps.pkg.outputs.version }},gitUserId=hotdata-dev,gitRepoId=sdk-python \
             --skip-validate-spec
 
       - name: Patch generated __version__ to read from package metadata
@@ -72,6 +72,31 @@ jobs:
           p.write_text(new)
           PY
 
+      - name: Patch generated pyproject.toml metadata
+        run: |
+          python3 - <<'PY'
+          import re, pathlib, sys
+          p = pathlib.Path("pyproject.toml")
+          src = p.read_text()
+          patches = [
+              (
+                  r'^keywords = \[.*\]$',
+                  'keywords = ["hotdata", "api-client", "data-platform"]',
+                  re.MULTILINE,
+              ),
+              (
+                  r'\[project\.urls\]\nRepository = "[^"]*"\n',
+                  '[project.urls]\nHomepage = "https://www.hotdata.dev"\nRepository = "https://github.com/hotdata-dev/sdk-python"\n',
+                  0,
+              ),
+          ]
+          for pattern, replacement, flags in patches:
+              src, n = re.subn(pattern, replacement, src, count=1, flags=flags)
+              if n != 1:
+                  sys.exit(f"Failed to patch pyproject.toml: pattern {pattern!r}")
+          p.write_text(src)
+          PY
+
       - name: Clean up generated artifacts
         run: |
           rm -f openapi.yaml

README.md

@@ -1,47 +1,43 @@
 # hotdata
 
-Official Python client for the [Hotdata](https://app.hotdata.dev) HTTP API: workspaces, connections, datasets, SQL queries, results, secrets, uploads, indexes, jobs, embedding providers, and workspace context.
-
-The package is produced with [OpenAPI Generator](https://openapi-generator.tech) from the Hotdata OpenAPI spec. 
+Official Python client for the [Hotdata](https://www.hotdata.dev) HTTP API: workspaces, connections, datasets, SQL queries, results, secrets, uploads, indexes, jobs, embedding providers, and workspace context.
 
 ## Requirements
 
 Python 3.9+
 
 ## Install
 
-From the repository:
-
 ```sh
-pip install "git+https://github.com/hotdata-dev/sdk-python.git"
+pip install hotdata
 ```
 
-From a local checkout (editable):
+For an unreleased revision:
 
 ```sh
-pip install -e .
+pip install "git+https://github.com/hotdata-dev/sdk-python.git"
 ```
 
-## Tests
+From a local checkout (editable):
 
 ```sh
-pytest
+pip install -e .
 ```
 
 ## Authentication
 
-The API uses **Bearer** JWTs and an **`X-Workspace-Id`** header on requests that are scoped to a workspace.
+The API uses an **API key** sent as `Authorization: Bearer <key>`, plus an **`X-Workspace-Id`** header on requests scoped to a workspace.
 
 ```python
 import hotdata
 
 configuration = hotdata.Configuration(
-    access_token="YOUR_ACCESS_TOKEN",
-    api_key={"WorkspaceId": "YOUR_WORKSPACE_ID"},
+    api_key="YOUR_API_KEY",
+    workspace_id="YOUR_WORKSPACE_ID",
 )
 ```
 
-`host` defaults to `https://app.hotdata.dev`. Override it if you target another environment.
+`host` defaults to `https://api.hotdata.dev`. Override it if you target another environment.
 
 ## Usage
 
@@ -50,8 +46,8 @@ import hotdata
 from hotdata.rest import ApiException
 
 configuration = hotdata.Configuration(
-    access_token="YOUR_ACCESS_TOKEN",
-    api_key={"WorkspaceId": "YOUR_WORKSPACE_ID"},
+    api_key="YOUR_API_KEY",
+    workspace_id="YOUR_WORKSPACE_ID",
 )
 
 with hotdata.ApiClient(configuration) as api_client:
@@ -66,13 +62,11 @@ Each `Api` class groups endpoints by resource. Construct the client, then call t
 
 ## API reference
 
-Generated Markdown for every operation and model is in [`docs/`](docs/):
+Generated Markdown for every operation and model is in [`docs/`](https://github.com/hotdata-dev/sdk-python/tree/main/docs):
 
-- Resource APIs: `docs/*Api.md` (for example [`docs/QueryApi.md`](docs/QueryApi.md))
+- Resource APIs: `docs/*Api.md` (for example [`QueryApi.md`](https://github.com/hotdata-dev/sdk-python/blob/main/docs/QueryApi.md))
 - Request and response models: `docs/<ModelName>.md`
 
-Use your editor or GitHub file search there instead of duplicating large tables in this file.
-
 ## Support
 
 Questions and issues: [github.com/hotdata-dev/sdk-python](https://github.com/hotdata-dev/sdk-python).

pyproject.toml

@@ -7,7 +7,7 @@ authors = [
 ]
 license = { text = "MIT" }
 readme = "README.md"
-keywords = ["OpenAPI", "OpenAPI-Generator", "Hotdata API"]
+keywords = ["hotdata", "api-client", "data-platform"]
 requires-python = ">=3.9"
 
 dependencies = [
@@ -18,7 +18,8 @@ dependencies = [
 ]
 
 [project.urls]
-Repository = "https://github.com/GIT_USER_ID/GIT_REPO_ID"
+Homepage = "https://www.hotdata.dev"
+Repository = "https://github.com/hotdata-dev/sdk-python"
 
 [tool.poetry]
 requires-poetry = ">=2.0"