hyperping 0.1.0__py3-none-any.whl

hyperping-0.1.0.dist-info/METADATA

@@ -0,0 +1,223 @@
+Metadata-Version: 2.4
+Name: hyperping
+Version: 0.1.0
+Summary: Python SDK for the Hyperping uptime monitoring and incident management API
+Project-URL: Homepage, https://github.com/develeap/hyperping-python
+Project-URL: Documentation, https://github.com/develeap/hyperping-python#readme
+Project-URL: Repository, https://github.com/develeap/hyperping-python
+Project-URL: Changelog, https://github.com/develeap/hyperping-python/blob/main/CHANGELOG.md
+Project-URL: Issues, https://github.com/develeap/hyperping-python/issues
+Author-email: Develeap <dev@develeap.com>
+License: MIT
+License-File: LICENSE
+Keywords: api-client,hyperping,incident,monitoring,status-page,uptime
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Internet :: WWW/HTTP
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+Requires-Dist: httpx>=0.26
+Requires-Dist: pydantic>=2.0
+Provides-Extra: dev
+Requires-Dist: mypy>=1.10; extra == 'dev'
+Requires-Dist: pydantic; extra == 'dev'
+Requires-Dist: pytest-cov; extra == 'dev'
+Requires-Dist: pytest>=8.0; extra == 'dev'
+Requires-Dist: respx>=0.21; extra == 'dev'
+Requires-Dist: ruff>=0.4; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# hyperping
+
+[![PyPI version](https://img.shields.io/pypi/v/hyperping.svg)](https://pypi.org/project/hyperping/)
+[![Python versions](https://img.shields.io/pypi/pyversions/hyperping.svg)](https://pypi.org/project/hyperping/)
+[![CI](https://github.com/develeap/hyperping-python/actions/workflows/ci.yml/badge.svg)](https://github.com/develeap/hyperping-python/actions/workflows/ci.yml)
+[![Coverage](https://codecov.io/gh/develeap/hyperping-python/branch/main/graph/badge.svg)](https://codecov.io/gh/develeap/hyperping-python)
+[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+[![Checked with mypy](https://www.mypy-lang.org/static/mypy_badge.svg)](https://mypy-lang.org/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+Python SDK for the [Hyperping](https://hyperping.io) uptime monitoring and incident management API.
+
+## Installation
+
+```bash
+pip install hyperping
+# or
+uv add hyperping
+```
+
+## Quick Start
+
+```python
+from hyperping import HyperpingClient, IncidentCreate, LocalizedText
+
+with HyperpingClient(api_key="sk_...") as client:
+    # List all monitors
+    monitors = client.list_monitors()
+    for m in monitors:
+        print(f"{m.name}: {'down' if m.down else 'up'}")
+
+    # Open an incident
+    incident = client.create_incident(
+        IncidentCreate(
+            title=LocalizedText(en="Service degradation"),
+            text=LocalizedText(en="Investigating elevated error rates"),
+            statuspages=["sp_your_uuid"],
+        )
+    )
+
+    # Resolve it
+    client.resolve_incident(incident.uuid, "All systems operational")
+```
+
+## Authentication
+
+Pass your API key directly or via environment variable:
+
+```python
+import os
+from hyperping import HyperpingClient
+
+# Constructor param
+client = HyperpingClient(api_key="sk_...")
+
+# From environment
+client = HyperpingClient(api_key=os.environ["HYPERPING_API_KEY"])
+```
+
+## Resources
+
+### Monitors
+
+```python
+monitors = client.list_monitors()
+monitor  = client.get_monitor("mon_uuid")
+created  = client.create_monitor(MonitorCreate(name="API", url="https://api.example.com"))
+client.pause_monitor("mon_uuid")
+client.resume_monitor("mon_uuid")
+client.delete_monitor("mon_uuid")
+
+# Reports
+reports = client.get_all_reports(period="30d")
+report  = client.get_monitor_report("mon_uuid", period="7d")
+```
+
+### Incidents
+
+```python
+incidents = client.list_incidents()
+incident  = client.get_incident("inci_uuid")
+created   = client.create_incident(IncidentCreate(...))
+client.add_incident_update("inci_uuid", AddIncidentUpdateRequest(...))
+client.resolve_incident("inci_uuid", "Fixed")
+client.delete_incident("inci_uuid")
+```
+
+### Maintenance Windows
+
+```python
+windows = client.list_maintenance()
+window  = client.get_maintenance("mw_uuid")
+created = client.create_maintenance(MaintenanceCreate(...))
+client.update_maintenance("mw_uuid", MaintenanceUpdate(name="New name"))
+client.delete_maintenance("mw_uuid")
+
+# Helpers
+active = client.get_active_maintenance()
+in_maint = client.is_monitor_in_maintenance("mon_uuid")
+```
+
+### Outages
+
+```python
+outages = client.list_outages()
+client.acknowledge_outage("out_uuid", message="On it")
+client.resolve_outage("out_uuid", message="Fixed")
+client.escalate_outage("out_uuid")
+```
+
+### Status Pages
+
+```python
+pages = client.list_status_pages(search="prod")
+page  = client.get_status_page("sp_uuid")
+created = client.create_status_page(StatusPageCreate(name="Prod", subdomain="prod-status"))
+client.update_status_page("sp_uuid", StatusPageUpdate(name="Production Status"))
+client.delete_status_page("sp_uuid")
+
+# Subscribers
+subs = client.list_subscribers("sp_uuid")
+sub  = client.add_subscriber("sp_uuid", "user@example.com")
+client.remove_subscriber("sp_uuid", sub.id)
+```
+
+## Error Handling
+
+```python
+from hyperping import (
+    HyperpingAPIError,
+    HyperpingAuthError,
+    HyperpingNotFoundError,
+    HyperpingRateLimitError,
+    HyperpingValidationError,
+)
+
+try:
+    monitor = client.get_monitor("mon_uuid")
+except HyperpingNotFoundError:
+    print("Monitor not found")
+except HyperpingRateLimitError as e:
+    print(f"Rate limited. Retry after {e.retry_after}s")
+except HyperpingAuthError:
+    print("Invalid API key")
+except HyperpingAPIError as e:
+    print(f"API error [{e.status_code}]: {e.message}")
+    print(f"Request ID: {e.request_id}")
+```
+
+## Retries and Circuit Breaker
+
+The SDK retries automatically on transient errors (5xx, 429) with exponential backoff and jitter. A circuit breaker prevents cascading failures.
+
+```python
+from hyperping import HyperpingClient
+from hyperping.client import RetryConfig, CircuitBreakerConfig
+
+client = HyperpingClient(
+    api_key="sk_...",
+    retry_config=RetryConfig(
+        max_retries=3,
+        initial_delay=1.0,
+        max_delay=30.0,
+        backoff_factor=2.0,
+    ),
+    circuit_breaker_config=CircuitBreakerConfig(
+        failure_threshold=5,
+        recovery_timeout=60.0,
+    ),
+)
+```
+
+## Type Safety
+
+This package ships a `py.typed` marker (PEP 561) and is fully typed. Works out of the box with mypy and pyright.
+
+## Contributing
+
+See [CONTRIBUTING.md](CONTRIBUTING.md).
+
+## License
+
+MIT — see [LICENSE](LICENSE).
+
+## Maintained by
+
+[Develeap](https://develeap.com)

hyperping-0.1.0.dist-info/RECORD

@@ -0,0 +1,16 @@
+hyperping/__init__.py,sha256=FRUfQfT1dnGtTJ3wWvyDR7vD4mC7d4xVFqniMV09L9E,3284
+hyperping/_incidents_mixin.py,sha256=tdhu2SauMBcXYaB2cQaV-Y2lNwanO32cUgK7prbnWgQ,6514
+hyperping/_maintenance_mixin.py,sha256=VeEcBqrsF5d9nmQ9f2LqKcLus-3TOoGtIU7UaevqJyg,6500
+hyperping/_monitors_mixin.py,sha256=0NJSoApejA2JsFzqSWhDy8E8V2Z5RNd62cG1sm3Ibec,7642
+hyperping/_outages_mixin.py,sha256=lBvQvz98KSQEl-93O0stX3hf3yvY5NQrPnylO-qt-DM,3030
+hyperping/_statuspages_mixin.py,sha256=yB9HR4nyptVYtT7VUeD-sb0Yv7dixryaDqqE9GLAN74,7133
+hyperping/_version.py,sha256=kUR5RAFc7HCeiqdlX36dZOHkUI5wI6V_43RpEcD8b-0,22
+hyperping/client.py,sha256=LS_gLY9Wv7Ti6VSie_u8ALrOxlRy8oXK8wKraOQLMPo,16322
+hyperping/endpoints.py,sha256=7caQ1Sg7HC1CRU6YLfOZg2MaCZ66O20vAZa2rf54dgg,7391
+hyperping/exceptions.py,sha256=h-HPxD3YehmarUsA5kbhVQmKaAt4FMikkv1hubvzITU,2637
+hyperping/models.py,sha256=BtWJgSlXvl7qcGIALdh0jcIKn-FVQnvvKT3sDmUDUiQ,25712
+hyperping/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+hyperping-0.1.0.dist-info/METADATA,sha256=LuFf9h5o7MaFULq4xICPoxSA-RxGG-r6ebJqON4a5Yw,6908
+hyperping-0.1.0.dist-info/WHEEL,sha256=QccIxa26bgl1E6uMy58deGWi-0aeIkkangHcxk2kWfw,87
+hyperping-0.1.0.dist-info/licenses/LICENSE,sha256=pvB2D2XndvHitDkGdap2LbX_xHULlj3wOBFIJ_oZIMM,1065
+hyperping-0.1.0.dist-info/RECORD,,

hyperping-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.29.0
+Root-Is-Purelib: true
+Tag: py3-none-any

hyperping-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Develeap
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.