uptimer-python-sdk 1.6.0rc0__tar.gz → 1.8.0__tar.gz

uptimer_python_sdk-1.8.0/.cursor/rules/sdk-docs-implemented-only.mdc

@@ -0,0 +1,47 @@
+---
+description: SDK docs describe only what this package implements — no gaps, no roadmap, no release process
+alwaysApply: true
+---
+
+# SDK docs describe only what this package implements
+
+Applies to everything a user of the published package reads: `README.md` (which
+is also the PyPI long description), docstrings under `src/`, and `examples/`.
+
+## The rule
+
+**Document only capabilities present in this package version.** That is all.
+
+A README is a contract for the package somebody just installed, not a status
+board for the work around it.
+
+## Do not write
+
+- "this SDK does not wrap those routes **yet**", "not implemented", "missing",
+  "unsupported" — anything that describes an absence;
+- "not in the published package", "until X is on PyPI", "use a checkout of this
+  repository" — release sequencing and workarounds;
+- ticket or issue numbers, internal milestones, or which release something is
+  planned for;
+- TODOs or roadmap notes in public docstrings.
+
+## Do instead
+
+- **Omit it.** A capability this package does not have simply does not appear.
+  The reader loses nothing: they cannot call it either way.
+- Where the HTTP API has something the package does not, the
+  [REST documentation](https://uptimer.myuptime.info/latest/reference/rest-api/)
+  covers it. Link that for the full reference when it helps — without saying
+  what is missing here.
+- State the **server** a capability needs when it is not the package minimum
+  ("needs an Uptimer 1.7.0+ server"). That is a fact about an implemented
+  feature, not a gap.
+- When something ships, add it to the docs in the same change that adds the
+  code.
+
+## Why
+
+Users read this to decide what to call. "We have not wrapped that yet" answers a
+question nobody asked and dates the moment it is written; a checkout instruction
+sends somebody around a problem that a later release quietly removed. Both have
+happened here.

uptimer_python_sdk-1.8.0/AGENTS.md

@@ -0,0 +1,32 @@
+# AGENTS.md — uptimer-python-sdk
+
+The public Python client for Uptimer. Fleet-wide rules apply (see the workspace
+`AGENTS.md`): trunk-based on `main`, no agent attribution, Commitizen subjects.
+
+## Documentation policy
+
+**SDK docs describe only what this package implements.** That is all.
+
+`README.md` (the PyPI long description), the docstrings under `src/`, and
+`examples/` document capabilities present in **this package version**. No "not
+wrapped yet", no checkout workarounds, no ticket numbers, no release
+sequencing. A capability this package does not have is **omitted** — the
+[REST documentation](https://uptimer.myuptime.info/latest/reference/rest-api/)
+covers the HTTP API in full, and may be linked for that.
+
+The same rule, in the form Cursor reads:
+[`.cursor/rules/sdk-docs-implemented-only.mdc`](.cursor/rules/sdk-docs-implemented-only.mdc).
+
+## Working here
+
+```sh
+task cq        # lint + type-check + tests (ruff, mypy, pytest)
+task test      # pytest alone
+task build     # sdist + wheel into dist/
+```
+
+- The package version tracks the Uptimer release it targets: 1.8.x speaks to
+  Uptimer 1.8.0 and later. `uptimer.__version__` is where the compatibility
+  minimum comes from, and `cz` bumps it with `pyproject.toml`.
+- **Never publish a prerelease** (rc/a/b/dev) to TestPyPI or PyPI. This package
+  ships final `X.Y.Z` only; publishing is an operator action.

{uptimer_python_sdk-1.6.0rc0 → uptimer_python_sdk-1.8.0}/CHANGELOG.md

@@ -1,3 +1,67 @@
+## 1.8.0 (2026-09-19)
+
+Targets Uptimer **1.8.0** and later.
+
+### Feat
+
+- **notifications**: `client.v2.notifications.destinations` — list, create, get,
+  update, delete, plus `set_enabled`, `make_default` and `send_test`. A
+  destination is one place a workspace's alerts can go: a Slack incoming
+  webhook, or any HTTP endpoint.
+- **notifications**: `client.v2.notifications.transformations` — list, create,
+  get, update, delete, plus `samples` (the field vocabulary a template may
+  read) and `preview` (the same judgement a save makes, storing nothing). A
+  template is stored only once it renders all three messages.
+- **notifications**: `client.v2.notifications.deliveries.all(...)` — the
+  delivery log, filtered by destination and by undelivered. Records are kept 30
+  days.
+- **delivery**: `client.v2.subjects(slug).delivery` and
+  `client.v2.monitoring.websites(id).delivery` — `get`, `replace` and `clear`
+  for which destinations one subject tells, and about what. The table is the
+  resource: a save replaces it rather than merging.
+- **signals**: `client.v2.subjects(slug).signals` — list, create, get, update
+  and delete. Reporting observations to an existing signal is unchanged.
+- **rules**: `client.v2.subjects(slug).rules` — list, create, get, update and
+  delete, with typed policy models (`RuleDocument`, `RuleInput`,
+  `RuleDecision`, `RuleWait`). A rule input citing another rule is `from_rule`
+  in Python, because `from` is a keyword.
+
+### Fix
+
+- **subjects**: a `workspace_id` given to `client.v2.subjects(slug, ws)` now
+  reaches the signal, rule and observation routes under it. Without it, a
+  caller holding the same subject slug in two workspaces was answered
+  `Ambiguous subject` by the server — by the one call that could have
+  disambiguated.
+- **compat**: `uptimer.__version__` is bumped with the package, so the minimum
+  server version it derives is the version this package targets. It had
+  drifted: 1.7.0 moved `pyproject.toml` alone, and the published client went on
+  accepting a 1.6.0 server.
+
+### Docs
+
+- The README documents only what this package implements, with runnable
+  examples for destinations, transformations, subject delivery, the delivery
+  log, signals and rules. The complete HTTP API — including anything not
+  wrapped here — is at
+  <https://uptimer.myuptime.info/latest/reference/rest-api/>.
+- That policy is now written down for contributors and agents in `AGENTS.md`
+  and `.cursor/rules/sdk-docs-implemented-only.mdc`.
+
+## 1.7.0 (2026-09-14)
+
+### Feat
+
+- change maintenance end time on Custom subjects
+- subject maintenance window client
+- acknowledge Website and Custom incidents on separate clients
+
+## 1.6.0 (2026-09-08)
+
+### Feat
+
+- **sdk**: list and create Website/Custom subjects
+
 ## 1.6.0-rc.0 (2026-08-30)
 
 ### Feat