devhelm 0.1.0__tar.gz

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

@@ -0,0 +1,53 @@
+name: CI
+
+on:
+  pull_request:
+  push:
+    branches: [main]
+
+permissions:
+  contents: read
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v4
+        with:
+          enable-cache: true
+      - uses: actions/setup-python@v5
+        with:
+          python-version: '3.13'
+      - run: uv sync
+      - run: uv run ruff check src/ tests/
+      - run: uv run ruff format --check src/ tests/
+
+  typecheck:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v4
+        with:
+          enable-cache: true
+      - uses: actions/setup-python@v5
+        with:
+          python-version: '3.13'
+      - run: uv sync
+      - run: uv run mypy src/
+
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ['3.11', '3.13']
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v4
+        with:
+          enable-cache: true
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - run: uv sync
+      - run: uv run pytest -v

devhelm-0.1.0/.github/workflows/release.yml

@@ -0,0 +1,144 @@
+name: Release
+
+on:
+  push:
+    tags: ['v*']
+
+permissions:
+  contents: write
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v4
+        with:
+          enable-cache: true
+      - uses: actions/setup-python@v5
+        with:
+          python-version: '3.13'
+      - run: uv sync
+      - run: uv run pytest -v
+      - run: uv run ruff check src/ tests/
+      - run: uv run python -m build
+      - uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  notify-monorepo:
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Trigger integration tests in monorepo
+        run: |
+          gh api repos/devhelmhq/mono/dispatches \
+            -f event_type=surface_release \
+            -f "client_payload[repo]=${{ github.repository }}" \
+            -f "client_payload[tag]=${{ github.ref_name }}" \
+            -f "client_payload[sha]=${{ github.sha }}"
+        env:
+          GH_TOKEN: ${{ secrets.MONOREPO_DISPATCH_TOKEN }}
+
+  publish:
+    runs-on: ubuntu-latest
+    needs: [build, notify-monorepo]
+    environment: production
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v4
+        with:
+          enable-cache: true
+      - uses: actions/setup-python@v5
+        with:
+          python-version: '3.13'
+      - run: uv sync
+      - run: uv run python -m build
+      - name: Publish to PyPI
+        run: uv run twine upload dist/*
+        env:
+          TWINE_USERNAME: __token__
+          TWINE_PASSWORD: ${{ secrets.PYPI_TOKEN }}
+      - name: Trigger publish verification in monorepo
+        run: |
+          gh api repos/devhelmhq/mono/dispatches \
+            -f event_type=surface_published \
+            -f "client_payload[repo]=${{ github.repository }}" \
+            -f "client_payload[tag]=${{ github.ref_name }}" \
+            -f "client_payload[sha]=${{ github.sha }}"
+        env:
+          GH_TOKEN: ${{ secrets.MONOREPO_DISPATCH_TOKEN }}
+
+  github-release:
+    runs-on: ubuntu-latest
+    needs: publish
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Create GitHub Release
+        run: |
+          gh release create "${{ github.ref_name }}" \
+            --title "${{ github.ref_name }}" \
+            --generate-notes
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+  post-publish:
+    runs-on: ubuntu-latest
+    needs: [publish, github-release]
+    if: always() && needs.publish.result == 'success'
+    steps:
+      - name: Extract version info
+        id: version
+        run: |
+          TAG="${{ github.ref_name }}"
+          VERSION="${TAG#v}"
+          echo "version=$VERSION" >> "$GITHUB_OUTPUT"
+
+          IFS='.' read -r MAJOR MINOR PATCH <<< "$VERSION"
+          if [[ "$MINOR" != "0" || "$MAJOR" != "0" ]] && [[ "$PATCH" == "0" ]]; then
+            echo "is_minor_plus=true" >> "$GITHUB_OUTPUT"
+          else
+            echo "is_minor_plus=false" >> "$GITHUB_OUTPUT"
+          fi
+
+      - name: Create Linear release ticket
+        if: env.LINEAR_API_KEY != ''
+        run: |
+          curl -s -X POST https://api.linear.app/graphql \
+            -H "Content-Type: application/json" \
+            -H "Authorization: ${{ secrets.LINEAR_API_KEY }}" \
+            -d '{
+              "query": "mutation($input: IssueCreateInput!) { issueCreate(input: $input) { success issue { identifier url } } }",
+              "variables": {
+                "input": {
+                  "teamId": "${{ vars.LINEAR_RELEASES_TEAM_ID }}",
+                  "projectId": "${{ vars.LINEAR_RELEASES_PROJECT_ID }}",
+                  "title": "Released: Python SDK v${{ steps.version.outputs.version }}",
+                  "description": "**Release:** https://github.com/${{ github.repository }}/releases/tag/${{ github.ref_name }}\n**CI run:** https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}\n**Commit:** ${{ github.sha }}"
+                }
+              }
+            }'
+        env:
+          LINEAR_API_KEY: ${{ secrets.LINEAR_API_KEY }}
+
+      - name: Create Linear changelog ticket (minor+ only)
+        if: steps.version.outputs.is_minor_plus == 'true' && env.LINEAR_API_KEY != ''
+        run: |
+          curl -s -X POST https://api.linear.app/graphql \
+            -H "Content-Type: application/json" \
+            -H "Authorization: ${{ secrets.LINEAR_API_KEY }}" \
+            -d '{
+              "query": "mutation($input: IssueCreateInput!) { issueCreate(input: $input) { success issue { identifier url } } }",
+              "variables": {
+                "input": {
+                  "teamId": "${{ vars.LINEAR_CONTENT_TEAM_ID }}",
+                  "title": "Changelog entry: Python SDK v${{ steps.version.outputs.version }}",
+                  "description": "Write changelog entry for https://github.com/${{ github.repository }}/releases/tag/${{ github.ref_name }}"
+                }
+              }
+            }'
+        env:
+          LINEAR_API_KEY: ${{ secrets.LINEAR_API_KEY }}

devhelm-0.1.0/.github/workflows/spec-check.yml

@@ -0,0 +1,71 @@
+name: Spec Check
+
+on:
+  repository_dispatch:
+    types: [spec_updated]
+
+permissions:
+  contents: write
+  issues: write
+  pull-requests: write
+
+jobs:
+  check-compatibility:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v4
+        with:
+          enable-cache: true
+      - uses: actions/setup-python@v5
+        with:
+          python-version: '3.13'
+
+      - name: Download latest OpenAPI spec from monorepo
+        run: |
+          gh api repos/devhelmhq/mono/contents/docs/openapi/monitoring-api.yaml \
+            -H "Accept: application/vnd.github.raw+json" \
+            -o docs/openapi/monitoring-api.json
+        env:
+          GH_TOKEN: ${{ secrets.MONOREPO_DISPATCH_TOKEN }}
+
+      - run: uv sync
+      - run: uv run pytest -v
+
+      - name: Regenerate types from spec
+        run: ./scripts/typegen.sh
+
+      - name: Check for type changes
+        id: diff
+        run: |
+          if git diff --quiet src/devhelm/_generated.py docs/openapi/; then
+            echo "changed=false" >> "$GITHUB_OUTPUT"
+          else
+            echo "changed=true" >> "$GITHUB_OUTPUT"
+          fi
+
+      - name: Open PR with updated types
+        if: steps.diff.outputs.changed == 'true'
+        run: |
+          git config user.name "github-actions[bot]"
+          git config user.email "github-actions[bot]@users.noreply.github.com"
+          branch="chore/update-api-types-$(date +%Y%m%d%H%M%S)"
+          git checkout -b "$branch"
+          git add src/devhelm/_generated.py docs/openapi/monitoring-api.json
+          git commit -m "chore: update generated API types from latest spec"
+          git push -u origin "$branch"
+          gh pr create \
+            --title "chore: update generated API types" \
+            --body "Auto-generated from latest OpenAPI spec in the monorepo." \
+            --base main
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Report failure
+        if: failure()
+        run: |
+          gh issue create \
+            --title "API spec change broke Python SDK build" \
+            --body "The monorepo pushed a spec update that caused CI failures.\n\nWorkflow: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}"
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}

devhelm-0.1.0/.gitignore

@@ -0,0 +1,207 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+#poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+#pdm.lock
+#pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+#pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Abstra
+# Abstra is an AI-powered process automation framework.
+# Ignore directories containing user credentials, local state, and settings.
+# Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#  that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#  and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#  you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Cursor
+#  Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
+#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
+#  refer to https://docs.cursor.com/context/ignore-files
+.cursorignore
+.cursorindexingignore
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/

devhelm-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 DevHelm
+
+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.

devhelm-0.1.0/Makefile

@@ -0,0 +1,33 @@
+.PHONY: build test lint lint-fix typecheck typegen clean release help
+
+build:  ## Build the package
+	uv run python -m build
+
+test:  ## Run unit tests
+	uv run pytest
+
+lint:  ## Run ruff linter + formatter check
+	uv run ruff check src/ tests/
+	uv run ruff format --check src/ tests/
+
+lint-fix:  ## Auto-fix lint and format issues
+	uv run ruff check --fix src/ tests/
+	uv run ruff format src/ tests/
+
+typecheck:  ## Run mypy strict type checking
+	uv run mypy src/
+
+typegen:  ## Regenerate Pydantic models from OpenAPI spec
+	./scripts/typegen.sh
+
+clean:  ## Remove build artifacts
+	rm -rf dist build *.egg-info src/*.egg-info
+
+release:  ## Release a new version: make release VERSION=0.1.0
+	@test -n "$(VERSION)" || (echo "Usage: make release VERSION=x.y.z" && exit 1)
+	./scripts/release.sh $(VERSION)
+
+help:  ## Show this help
+	@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-15s\033[0m %s\n", $$1, $$2}'
+
+.DEFAULT_GOAL := help

devhelm-0.1.0/PKG-INFO

@@ -0,0 +1,171 @@
+Metadata-Version: 2.4
+Name: devhelm
+Version: 0.1.0
+Summary: DevHelm SDK for Python — typed client for monitors, incidents, alerting, and more
+Project-URL: Homepage, https://github.com/devhelmhq/sdk-python
+Project-URL: Repository, https://github.com/devhelmhq/sdk-python.git
+Project-URL: Issues, https://github.com/devhelmhq/sdk-python/issues
+Author-email: DevHelm <hello@devhelm.io>
+License-Expression: MIT
+License-File: LICENSE
+Keywords: api-client,devhelm,monitoring,sdk,uptime
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+Requires-Dist: httpx>=0.27
+Requires-Dist: pydantic[email]>=2.0
+Description-Content-Type: text/markdown
+
+# DevHelm Python SDK
+
+Typed Python client for the [DevHelm](https://devhelm.io) monitoring API — monitors, incidents, alerting, and more.
+
+## Installation
+
+```bash
+pip install devhelm
+```
+
+## Quick Start
+
+```python
+from devhelm import Devhelm
+
+client = Devhelm(
+    token="your-api-token",
+    org_id="your-org-id",
+    workspace_id="your-workspace-id",
+)
+
+# List all monitors
+monitors = client.monitors.list()
+for m in monitors:
+    print(f"{m.name} — {m.type}")
+
+# Create a monitor
+monitor = client.monitors.create({
+    "name": "My API Health",
+    "type": "HTTP",
+    "config": {"url": "https://api.example.com/health", "method": "GET"},
+    "frequencySeconds": 60,
+    "regions": ["us-east"],
+})
+
+# Get a single monitor
+monitor = client.monitors.get(monitor.id)
+
+# Pause / resume
+client.monitors.pause(monitor.id)
+client.monitors.resume(monitor.id)
+
+# Delete
+client.monitors.delete(monitor.id)
+```
+
+## Configuration
+
+```python
+from devhelm import Devhelm
+
+client = Devhelm(
+    token="your-api-token",           # required (or DEVHELM_API_TOKEN env var)
+    org_id="1",                        # required (or DEVHELM_ORG_ID env var)
+    workspace_id="1",                  # required (or DEVHELM_WORKSPACE_ID env var)
+    base_url="https://api.devhelm.io", # optional, defaults to production
+)
+```
+
+Environment variables are used as fallbacks when constructor arguments are not provided:
+
+| Parameter      | Env Variable            |
+| -------------- | ----------------------- |
+| `token`        | `DEVHELM_API_TOKEN`     |
+| `org_id`       | `DEVHELM_ORG_ID`        |
+| `workspace_id` | `DEVHELM_WORKSPACE_ID`  |
+
+## Resources
+
+The client exposes the following resource modules:
+
+| Resource                | Description                      |
+| ----------------------- | -------------------------------- |
+| `client.monitors`       | HTTP, DNS, TCP, ICMP, MCP, and Heartbeat monitors |
+| `client.incidents`      | Manual and auto-detected incidents |
+| `client.alert_channels` | Slack, email, webhook, and other alert channels |
+| `client.notification_policies` | Routing rules for alerts   |
+| `client.environments`   | Environment grouping (prod, staging, etc.) |
+| `client.secrets`        | Encrypted secrets for monitor auth |
+| `client.tags`           | Organize monitors with tags      |
+| `client.resource_groups`| Logical resource groups           |
+| `client.webhooks`       | Outgoing webhook endpoints        |
+| `client.api_keys`       | API key management                |
+| `client.dependencies`   | Service dependency tracking       |
+| `client.deploy_lock`    | Deploy lock for safe deployments  |
+| `client.status`         | Dashboard overview                |
+
+## Pagination
+
+List methods auto-paginate by default. For manual page control:
+
+```python
+# Auto-paginate (fetches all pages)
+all_monitors = client.monitors.list()
+
+# Manual page control
+page = client.monitors.list_page(page=0, size=20)
+print(page.data)       # list of monitors
+print(page.has_next)   # True if more pages
+print(page.has_prev)   # True if previous page exists
+
+# Cursor pagination (for check results)
+results = client.monitors.results(monitor_id, limit=50)
+print(results.data)
+print(results.next_cursor)
+print(results.has_more)
+```
+
+## Error Handling
+
+```python
+from devhelm import Devhelm, DevhelmError, AuthError
+
+client = Devhelm(token="bad-token", org_id="1", workspace_id="1")
+
+try:
+    client.monitors.list()
+except AuthError as e:
+    print(f"Auth failed: {e.message} (HTTP {e.status})")
+except DevhelmError as e:
+    print(f"API error [{e.code}]: {e.message}")
+```
+
+Error codes: `AUTH`, `NOT_FOUND`, `CONFLICT`, `VALIDATION`, `API`.
+
+## Development
+
+```bash
+# Install dependencies
+uv sync
+
+# Run tests
+make test
+
+# Lint + format check
+make lint
+
+# Type check
+make typecheck
+
+# Regenerate types from OpenAPI spec
+make typegen
+```
+
+## License
+
+MIT