diff --git a/README.md b/README.md index 448ce64..59393d2 100644 --- a/README.md +++ b/README.md @@ -27,8 +27,11 @@ created = client.create_webhook( url="https://your-service.example/tidelight", events=["research.job.completed", "research.job.failed"], ) -# Persist this securely; the server only returns a signing secret on create or rotation. -save_secret(created["signing_secret"]) +signing_secret = created.get("signing_secret") +if not signing_secret: + raise RuntimeError("The create response did not include its one-time signing secret") +# TODO: Persist signing_secret with your approved secrets manager before +# finishing setup. Do not print it. It cannot be recovered by listing the endpoint. deliveries = client.list_webhook_deliveries() ``` diff --git a/pyproject.toml b/pyproject.toml index 1a4c2aa..d1807c4 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -7,7 +7,16 @@ name = "tidelight-sdk" version = "0.1.0" description = "Tidelight Intelligence Cloud Python client (unpublished)" requires-python = ">=3.10" +readme = "README.md" +keywords = ["tidelight", "research", "market-intelligence", "webhooks"] +classifiers = ["Programming Language :: Python :: 3 :: Only"] license = { text = "Proprietary" } +[project.urls] +Homepage = "https://tidelight.app/developers/packages/python" +Documentation = "https://dev.tidelight.app/api" +Repository = "https://github.com/TidelightOrg/tidelight/tree/main/sdk/python" +Issues = "https://github.com/TidelightOrg/tidelight/issues" + [tool.setuptools.packages.find] where = ["src"]