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

{uptimer_python_sdk-0.2.0 → uptimer_python_sdk-0.3.0}/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: uptimer-python-sdk
-Version: 0.2.0
+Version: 0.3.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.3.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.2.0 → uptimer_python_sdk-0.3.0}/pyproject.toml

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

{uptimer_python_sdk-0.2.0 → uptimer_python_sdk-0.3.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.3.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.3.0}/uv.lock

@@ -1147,8 +1147,8 @@ wheels = [
 ]
 
 [[package]]
-name = "uptimer"
-version = "0.2.0"
+name = "uptimer-python-sdk"
+version = "0.3.0"
 source = { editable = "." }
 dependencies = [
     { name = "httpx" },