hyperping 0.1.0__tar.gz

hyperping-0.1.0/.github/CODEOWNERS

@@ -0,0 +1,5 @@
+# All files — Develeap team is the default reviewer
+* @develeap/maintainers
+
+# Workflows require an extra eye
+.github/workflows/ @KhaledSalhab-Develeap

hyperping-0.1.0/.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,67 @@
+name: Bug Report
+description: Something isn't working as expected
+labels: ["bug", "triage"]
+assignees: ["KhaledSalhab-Develeap"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thank you for taking the time to report a bug! Please fill in as much detail as possible.
+
+  - type: input
+    id: version
+    attributes:
+      label: hyperping version
+      description: Output of `pip show hyperping | grep Version`
+      placeholder: "0.1.0"
+    validations:
+      required: true
+
+  - type: input
+    id: python
+    attributes:
+      label: Python version
+      description: Output of `python --version`
+      placeholder: "3.12.0"
+    validations:
+      required: true
+
+  - type: textarea
+    id: description
+    attributes:
+      label: What happened?
+      description: A clear description of the bug.
+    validations:
+      required: true
+
+  - type: textarea
+    id: expected
+    attributes:
+      label: What did you expect?
+    validations:
+      required: true
+
+  - type: textarea
+    id: reproduce
+    attributes:
+      label: Steps to reproduce
+      description: Minimal code snippet or steps that reproduce the issue.
+      render: python
+    validations:
+      required: true
+
+  - type: textarea
+    id: traceback
+    attributes:
+      label: Full traceback (if any)
+      render: text
+
+  - type: checkboxes
+    id: checklist
+    attributes:
+      label: Checklist
+      options:
+        - label: I have searched existing issues and this is not a duplicate.
+          required: true
+        - label: I am using the latest version of `hyperping`.
+          required: false

hyperping-0.1.0/.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,8 @@
+blank_issues_enabled: false
+contact_links:
+  - name: Hyperping API Docs
+    url: https://hyperping.io/docs
+    about: Official Hyperping API documentation
+  - name: Develeap
+    url: https://develeap.com
+    about: The team behind this SDK

hyperping-0.1.0/.github/ISSUE_TEMPLATE/feature_request.yml

@@ -0,0 +1,38 @@
+name: Feature Request
+description: Suggest an improvement or new capability
+labels: ["enhancement"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Have an idea? We'd love to hear it. Please describe it clearly below.
+
+  - type: textarea
+    id: problem
+    attributes:
+      label: What problem does this solve?
+      description: Describe the use case or limitation you are running into.
+    validations:
+      required: true
+
+  - type: textarea
+    id: solution
+    attributes:
+      label: Proposed solution
+      description: What would you like to see? Code examples welcome.
+    validations:
+      required: true
+
+  - type: textarea
+    id: alternatives
+    attributes:
+      label: Alternatives you have considered
+      description: Any workarounds you currently use?
+
+  - type: checkboxes
+    id: checklist
+    attributes:
+      label: Checklist
+      options:
+        - label: I have searched existing issues and this is not a duplicate.
+          required: true

hyperping-0.1.0/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,22 @@
+## What does this PR do?
+
+<!-- One or two sentences. Link to the issue it closes if applicable. -->
+
+Closes #
+
+## Type of change
+
+- [ ] Bug fix
+- [ ] New feature
+- [ ] Refactor / clean-up
+- [ ] Documentation
+- [ ] CI / tooling
+
+## Checklist
+
+- [ ] Tests added or updated
+- [ ] `uv run pytest` passes locally
+- [ ] `uv run mypy src` passes with no errors
+- [ ] `uv run ruff check src tests` passes
+- [ ] `CHANGELOG.md` updated (for user-visible changes)
+- [ ] No hardcoded secrets, credentials, or internal paths

hyperping-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,41 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.11", "3.12", "3.13"]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: astral-sh/setup-uv@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: uv sync --all-extras
+
+      - name: Lint
+        run: uv run ruff check src tests
+
+      - name: Type check
+        run: uv run mypy src
+
+      - name: Test
+        run: uv run pytest --cov=hyperping --cov-report=xml
+
+      - name: Upload coverage to Codecov
+        if: matrix.python-version == '3.12'
+        uses: codecov/codecov-action@v4
+        with:
+          files: coverage.xml
+          fail_ci_if_error: false

hyperping-0.1.0/.github/workflows/publish.yml

@@ -0,0 +1,48 @@
+name: Publish to PyPI
+
+on:
+  push:
+    tags: ["v*"]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v5
+        with: { python-version: "3.12" }
+      - run: uv sync --all-extras
+      - run: uv run pytest                    # gate — no publish on red tests
+      - run: uv build
+      - uses: actions/upload-artifact@v4
+        with: { name: dist, path: dist/ }
+
+  publish-testpypi:
+    needs: [build]
+    if: "github.ref_type == 'tag' && startsWith(github.ref_name, 'v') && contains(github.ref_name, '-')"
+    runs-on: ubuntu-latest
+    environment:
+      name: testpypi
+      url: https://test.pypi.org/p/hyperping
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@v4
+        with: { name: dist, path: dist/ }
+      - uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          repository-url: https://test.pypi.org/legacy/
+
+  publish-pypi:
+    needs: [build]
+    if: "github.ref_type == 'tag' && startsWith(github.ref_name, 'v') && !contains(github.ref_name, '-')"
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/hyperping
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@v4
+        with: { name: dist, path: dist/ }
+      - uses: pypa/gh-action-pypi-publish@release/v1

hyperping-0.1.0/.gitignore

@@ -0,0 +1,33 @@
+# Python
+__pycache__/
+*.py[cod]
+*.pyo
+*.pyd
+*.so
+*.egg
+*.egg-info/
+dist/
+build/
+.eggs/
+.venv/
+venv/
+
+# Test & coverage
+.coverage
+coverage.xml
+.pytest_cache/
+htmlcov/
+
+# Type checking
+.mypy_cache/
+
+# IDEs
+.vscode/
+.idea/
+
+# OS
+.DS_Store
+
+# Local dev tooling
+.claude/
+dist/

hyperping-0.1.0/CHANGELOG.md

@@ -0,0 +1,19 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.1.0] — 2026-03-31
+
+### Added
+
+- Initial release of the `hyperping` Python SDK.
+- `HyperpingClient` with full support for Monitors, Incidents, Maintenance Windows, Outages, and Status Pages.
+- Automatic retry with exponential backoff and jitter on transient errors (5xx, 429).
+- Circuit breaker pattern to prevent cascading failures.
+- Typed Pydantic v2 models for all API resources.
+- `py.typed` marker for PEP 561 compliance.
+- CI matrix across Python 3.11, 3.12, 3.13.
+- OIDC trusted publisher workflow for PyPI releases (no stored secrets).

hyperping-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,35 @@
+# Contributing
+
+Thank you for your interest in contributing to `hyperping`!
+
+## Setup
+
+```bash
+git clone https://github.com/develeap/hyperping-python.git
+cd hyperping-python
+uv sync --all-extras
+```
+
+## Running tests
+
+```bash
+uv run pytest -v
+```
+
+## Linting and type checking
+
+```bash
+uv run ruff check src tests
+uv run mypy src
+```
+
+## Pull requests
+
+1. Fork the repo and create a branch from `main`.
+2. Write tests for any new behaviour.
+3. Ensure all checks pass locally.
+4. Open a PR — a maintainer will review it.
+
+## Reporting issues
+
+Open an issue at https://github.com/develeap/hyperping-python/issues.

hyperping-0.1.0/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.

hyperping-0.1.0/PKG-INFO

@@ -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)