uptimer-python-sdk 0.2.0__tar.gz → 0.4.0__tar.gz

uptimer_python_sdk-0.4.0/CHANGELOG.md

@@ -0,0 +1,25 @@
+## 0.4.0 (2026-07-15)
+
+### Feat
+
+- assign regions (by name) when creating or updating a rule via `rules.create`/`rules.update`; rules now expose a `regions` field
+
+## 0.3.0 (2025-08-19)
+
+### Feat
+
+- self-hosted client now requires a base_url, added cloud client, updated docs
+
+## 0.2.0 (2025-08-10)
+
+### Feat
+
+- create/update/delete rule methods.
+- added method to get all rules
+- added regions and get rule API
+- added getting workspace list
+- add Cursor IDE configuration for testing and development
+
+### Fix
+
+- fixed dependencies in pyproject.toml

{uptimer_python_sdk-0.2.0 → uptimer_python_sdk-0.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: uptimer-python-sdk
-Version: 0.2.0
+Version: 0.4.0
 Summary: A Python SDK for uptimer
 Project-URL: Repository, https://github.com/myuptime-info/uptimer-python-sdk
 Author-email: Roman Zadoev <zadoev@gmail.com>
@@ -13,7 +13,11 @@ Description-Content-Type: text/markdown
 
 # Uptimer Python SDK
 
-A Python SDK for [uptimer](https://uptimer.myuptime.info/) - a monitoring and uptime checking service.
+![Uptimer](https://static.myuptime.info/61uvxp/icon.png)
+
+A Python SDK for uptimer - a monitoring and uptime checking service.
+* [uptimer self-hosted](https://uptimer.myuptime.info)
+* [myuptime.info](https://myuptime.info)
 
 ## License
 
@@ -21,8 +25,40 @@ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file
 
 For third-party license information, see the [NOTICE](NOTICE) file.
 
+## Installation 
+
+```shell
+pip install uptimer-python-sdk
+```
+
+or 
+```shell
+uv add uptimer-python-sdk
+```
+
 ## Usage
 
+### Create client
+
+#### self-hosted
+
+```python
+from uptimer.client import UptimerClient
+client = UptimerClient(
+    api_key="your-api-key-here",
+    base_url="http://127.0.0.1:2517/api",  # or your custom base URL
+)
+```
+
+#### cloud  
+```python
+from uptimer.client import UptimerCloudClient
+client = UptimerCloudClient(
+    api_key="your-api-key-here",
+)
+```
+
+### Basic example
 ```python
 from uptimer.client import UptimerClient
 from uptimer.models.rule import CreateRuleRequest, RuleRequest, RuleResponse, RuleResponseBody

{uptimer_python_sdk-0.2.0 → uptimer_python_sdk-0.4.0}/README.md

@@ -1,6 +1,10 @@
 # Uptimer Python SDK
 
-A Python SDK for [uptimer](https://uptimer.myuptime.info/) - a monitoring and uptime checking service.
+![Uptimer](https://static.myuptime.info/61uvxp/icon.png)
+
+A Python SDK for uptimer - a monitoring and uptime checking service.
+* [uptimer self-hosted](https://uptimer.myuptime.info)
+* [myuptime.info](https://myuptime.info)
 
 ## License
 
@@ -8,8 +12,40 @@ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file
 
 For third-party license information, see the [NOTICE](NOTICE) file.
 
+## Installation 
+
+```shell
+pip install uptimer-python-sdk
+```
+
+or 
+```shell
+uv add uptimer-python-sdk
+```
+
 ## Usage
 
+### Create client
+
+#### self-hosted
+
+```python
+from uptimer.client import UptimerClient
+client = UptimerClient(
+    api_key="your-api-key-here",
+    base_url="http://127.0.0.1:2517/api",  # or your custom base URL
+)
+```
+
+#### cloud  
+```python
+from uptimer.client import UptimerCloudClient
+client = UptimerCloudClient(
+    api_key="your-api-key-here",
+)
+```
+
+### Basic example
 ```python
 from uptimer.client import UptimerClient
 from uptimer.models.rule import CreateRuleRequest, RuleRequest, RuleResponse, RuleResponseBody

uptimer_python_sdk-0.4.0/Taskfile.yml

@@ -0,0 +1,54 @@
+# go-task runner for the uptimer Python SDK. `task --list` shows everything.
+# All tooling goes through `uv` (deps pinned by uv.lock), so local == CI.
+# Release/publish flow (matches the fleet rollout — release, then publish):
+#   task release      # cz bump (version + CHANGELOG + tag) + push
+#   task pypi-test    # validate on TestPyPI
+#   task pypi         # publish to PyPI (only after the release)
+version: '3'
+
+tasks:
+  build:
+    desc: Build the sdist + wheel into dist/ (uv build).
+    cmds:
+      - rm -rf dist
+      - uv build
+
+  test:
+    desc: Run the test suite (uv run pytest).
+    cmds:
+      - uv run pytest
+
+  lint:
+    desc: Lint + type-check (ruff + mypy).
+    cmds:
+      - uv run ruff check .
+      - uv run mypy src
+
+  cq:
+    desc: 'Code quality gate: lint + test.'
+    cmds:
+      - task: lint
+      - task: test
+
+  release:
+    desc: 'Cut a release: cq (lint + test), then `cz bump` (version + CHANGELOG + tag) + push. Commit your changes first.'
+    cmds:
+      - task: cq
+      - cz bump --yes
+      # bump commit + the tag cz just made; --follow-tags pushes only reachable tags.
+      - git push --follow-tags
+      - 'echo ">> released v$(cz version --project) — now publish with: task pypi"'
+
+  pypi-test:
+    desc: 'Build + upload to TestPyPI (needs a token: TWINE_USERNAME=__token__ TWINE_PASSWORD=pypi-…).'
+    deps: [build]
+    cmds:
+      - uv run twine check dist/*
+      - uv run twine upload --repository-url https://test.pypi.org/legacy/ dist/*
+
+  pypi:
+    desc: 'Build + upload to PyPI (needs a token). Do this only AFTER `task release`.'
+    deps: [build]
+    cmds:
+      - uv run twine check dist/*
+      - uv run twine upload dist/*

{uptimer_python_sdk-0.2.0 → uptimer_python_sdk-0.4.0}/examples/06_create_rule.py

@@ -11,6 +11,10 @@ from uptimer.models.rule import (
 client = UptimerClient(api_key="your-api-key-here")
 workspace_id = "your-workspace-id-here"
 
+# Regions are matched by name. List them to see what's available on your instance;
+# a rule with no regions is never checked and stays at "No Data", so assign at least one.
+region_names = [region.name for region in client.v1.regions.all()]
+
 # Create a new rule
 rule = client.v1.rules.create(
     CreateRuleRequest(
@@ -29,7 +33,9 @@ rule = client.v1.rules.create(
             body=RuleResponseBody(content="expected response"),
             kind="rule_response",
         ),
+        regions=region_names[:1],  # assign the first available region
     ),
 )
 
 print(f"Created rule: {rule.name} (ID: {rule.id})")
+print(f"Assigned regions: {rule.regions}")

{uptimer_python_sdk-0.2.0 → uptimer_python_sdk-0.4.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "uptimer-python-sdk"
-version = "0.2.0"
+version = "0.4.0"
 description = "A Python SDK for uptimer"
 readme = "README.md"
 requires-python = ">=3.9"

{uptimer_python_sdk-0.2.0 → uptimer_python_sdk-0.4.0}/src/uptimer/__init__.py

@@ -1,3 +1,3 @@
 """Uptimer Python SDK."""
 
-__version__ = "0.1.0"
+__version__ = "0.4.0"

{uptimer_python_sdk-0.2.0 → uptimer_python_sdk-0.4.0}/src/uptimer/client.py

@@ -9,8 +9,8 @@ from uptimer.http import UptimerHttpLib
 class UptimerClient:
     v1: V1Endpoint
 
-    def __init__(self, api_key: str, base_url: str | None = None):
-        self.set_uptimer_http_lib(UptimerHttpLib(api_key, base_url))
+    def __init__(self, api_key: str, base_url: str):
+        self._http_lib = UptimerHttpLib(api_key, base_url)
         self.v1 = V1Endpoint(self._http_lib)
 
     def version(self) -> str:
@@ -19,3 +19,8 @@ class UptimerClient:
 
     def set_uptimer_http_lib(self, http_lib: UptimerHttpLib) -> None:
         self._http_lib = http_lib
+
+
+class UptimerCloudClient(UptimerClient):
+    def __init__(self, api_key: str):
+        super().__init__(api_key, "https://api.myuptime.info")

{uptimer_python_sdk-0.2.0 → uptimer_python_sdk-0.4.0}/src/uptimer/http.py

@@ -13,10 +13,7 @@ class WorkspacesEndpoint(BaseEndpoint):
 
 
 class UptimerHttpLib:
-    def __init__(self, api_key: str, base_url: str | None = None):
-        if base_url is None:
-            base_url = "https://api.uptimer.com"
-
+    def __init__(self, api_key: str, base_url: str):
         self._base_url = base_url.rstrip("/")
         self._http_client = httpx.Client(
             base_url=base_url,

{uptimer_python_sdk-0.2.0 → uptimer_python_sdk-0.4.0}/src/uptimer/models/rule.py

@@ -1,6 +1,6 @@
 from __future__ import annotations
 
-from dataclasses import dataclass
+from dataclasses import dataclass, field
 
 
 @dataclass
@@ -34,6 +34,9 @@ class BaseRule:
     workspace_id: str  # workspace id
     request: RuleRequest  # request configuration
     response: RuleResponse  # response validation
+    # region names the rule runs in (matched by name). A rule with no regions is
+    # never checked and stays at "No Data" — assign at least one to monitor it.
+    regions: list[str] = field(default_factory=list)
     kind: str = "rule"
 
 

{uptimer_python_sdk-0.2.0 → uptimer_python_sdk-0.4.0}/tests/test_rules_endpoint.py

@@ -314,7 +314,7 @@ def test_create_rule(
     httpx_mock.add_response(
         method="POST",
         json=api_response(rule_result),
-        match_content=b'{"name":"My Test Rule","interval":60,"workspace_id":"03075d25-6cad-4205-ad83-2da1bd8fad9c","request":{"url":"https://example.com","method":"GET","content_type":"application/json","data":"","kind":"rule_request"},"response":{"statuses":[200],"body":{"content":"expected response","kind":"rule_response_body"},"kind":"rule_response"},"kind":"rule"}',
+        match_content=b'{"name":"My Test Rule","interval":60,"workspace_id":"03075d25-6cad-4205-ad83-2da1bd8fad9c","request":{"url":"https://example.com","method":"GET","content_type":"application/json","data":"","kind":"rule_request"},"response":{"statuses":[200],"body":{"content":"expected response","kind":"rule_response_body"},"kind":"rule_response"},"regions":[],"kind":"rule"}',
     )
 
     rule_object = uptimer_client.v1.rules.create(create_request)
@@ -343,6 +343,67 @@ def test_create_rule(
     assert rule_object.response.kind == response_data["kind"]
 
 
+def test_create_rule_with_regions(
+    uptimer_client: UptimerClient,
+    httpx_mock: HTTPXMock,
+):
+    """A rule created with regions sends them in the payload and parses them back."""
+    workspace_id = "03075d25-6cad-4205-ad83-2da1bd8fad9c"
+    rule_id = "d901834d-5768-46ae-91f5-7974b0c764b2"
+
+    create_request = CreateRuleRequest(
+        name="Regioned Rule",
+        interval=60,
+        workspace_id=workspace_id,
+        request=RuleRequest(
+            url="https://example.com",
+            method="GET",
+            content_type="application/json",
+            data="",
+            kind="rule_request",
+        ),
+        response=RuleResponse(
+            statuses=[200],
+            body=RuleResponseBody(content=""),
+            kind="rule_response",
+        ),
+        regions=["eu-west", "us-east"],
+        kind="rule",
+    )
+
+    rule_result = {
+        "id": rule_id,
+        "name": "Regioned Rule",
+        "interval": 60,
+        "workspace_id": workspace_id,
+        "request": {
+            "url": "https://example.com",
+            "method": "GET",
+            "content_type": "application/json",
+            "data": "",
+            "kind": "rule_request",
+        },
+        "response": {
+            "statuses": [200],
+            "body": {"content": "", "kind": "rule_response_body"},
+            "kind": "rule_response",
+        },
+        "regions": ["eu-west", "us-east"],
+        "kind": "rule",
+    }
+
+    httpx_mock.add_response(
+        method="POST",
+        json=api_response(rule_result),
+        match_content=b'{"name":"Regioned Rule","interval":60,"workspace_id":"03075d25-6cad-4205-ad83-2da1bd8fad9c","request":{"url":"https://example.com","method":"GET","content_type":"application/json","data":"","kind":"rule_request"},"response":{"statuses":[200],"body":{"content":"","kind":"rule_response_body"},"kind":"rule_response"},"regions":["eu-west","us-east"],"kind":"rule"}',
+    )
+
+    rule_object = uptimer_client.v1.rules.create(create_request)
+
+    assert rule_object.id == rule_id
+    assert rule_object.regions == ["eu-west", "us-east"]
+
+
 def test_update_rule_with_rule(
     uptimer_client: UptimerClient,
     httpx_mock: HTTPXMock,
@@ -398,7 +459,7 @@ def test_update_rule_with_rule(
     httpx_mock.add_response(
         method="POST",
         json=api_response(rule_result),
-        match_content=b'{"name":"Updated Rule Name","interval":120,"workspace_id":"03075d25-6cad-4205-ad83-2da1bd8fad9c","request":{"url":"https://updated-example.com","method":"POST","content_type":"application/json","data":"{\\"key2\\": \\"value\\"}","kind":"rule_request"},"response":{"statuses":[200,201],"body":{"content":"updated expected response","kind":"rule_response_body"},"kind":"rule_response"},"kind":"rule"}',
+        match_content=b'{"name":"Updated Rule Name","interval":120,"workspace_id":"03075d25-6cad-4205-ad83-2da1bd8fad9c","request":{"url":"https://updated-example.com","method":"POST","content_type":"application/json","data":"{\\"key2\\": \\"value\\"}","kind":"rule_request"},"response":{"statuses":[200,201],"body":{"content":"updated expected response","kind":"rule_response_body"},"kind":"rule_response"},"regions":[],"kind":"rule"}',
     )
 
     rule_object = uptimer_client.v1.rules.update(rule_id, update_request)
@@ -481,7 +542,7 @@ def test_update_rule_with_create_request(
     httpx_mock.add_response(
         method="POST",
         json=api_response(rule_result),
-        match_content=b'{"name":"Updated Rule Name","interval":120,"workspace_id":"03075d25-6cad-4205-ad83-2da1bd8fad9c","request":{"url":"https://updated-example.com","method":"POST","content_type":"application/json","data":"{\\"key2\\": \\"value\\"}","kind":"rule_request"},"response":{"statuses":[200,201],"body":{"content":"updated expected response","kind":"rule_response_body"},"kind":"rule_response"},"kind":"rule"}',
+        match_content=b'{"name":"Updated Rule Name","interval":120,"workspace_id":"03075d25-6cad-4205-ad83-2da1bd8fad9c","request":{"url":"https://updated-example.com","method":"POST","content_type":"application/json","data":"{\\"key2\\": \\"value\\"}","kind":"rule_request"},"response":{"statuses":[200,201],"body":{"content":"updated expected response","kind":"rule_response_body"},"kind":"rule_response"},"regions":[],"kind":"rule"}',
     )
 
     rule_object = uptimer_client.v1.rules.update(rule_id, update_request)