uptimer-python-sdk 0.2.0__tar.gz

uptimer_python_sdk-0.2.0/.gitignore

@@ -0,0 +1,167 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$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
+
+# 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
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# 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
+.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 added to the global gitignore or merged into this project gitignore.  For a PyCharm
+#  project, it is recommended to include the following files:
+#  .idea/
+#  *.iml
+#  *.ipr
+#  *.iws
+
+# uv
+.uv/
+.idea/
+sandbox.py 

uptimer_python_sdk-0.2.0/.pre-commit-config.yaml

@@ -0,0 +1,13 @@
+repos:
+  - repo: local
+    hooks:
+      - id: mypy-diff
+        name: mypy on staged files only
+        entry: ./tools/mypy-diff.sh
+        language: system
+        types: [ python ]
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.12.5
+    hooks:
+      - id: ruff
+        args: [--fix]

uptimer_python_sdk-0.2.0/.vscode/extensions.json

@@ -0,0 +1,20 @@
+{
+    "recommendations": [
+        "ms-python.python",
+        "ms-python.vscode-pylance",
+        "charliermarsh.ruff",
+        "ms-python.black-formatter",
+        "ms-python.flake8",
+        "ms-python.mypy-type-checker",
+        "ms-python.pytest-adapter",
+        "ms-vscode.test-adapter-converter",
+        "ms-vscode.vscode-json",
+        "redhat.vscode-yaml",
+        "ms-vscode.hexeditor",
+        "ms-vscode.vscode-typescript-next",
+        "bradlc.vscode-tailwindcss",
+        "esbenp.prettier-vscode",
+        "ms-vscode.vscode-js-debug",
+        "ms-vscode.vscode-js-debug-companion"
+    ]
+}

uptimer_python_sdk-0.2.0/.vscode/launch.json

@@ -0,0 +1,42 @@
+{
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "Python: Current File",
+            "type": "debugpy",
+            "request": "launch",
+            "program": "${file}",
+            "console": "integratedTerminal",
+            "justMyCode": true,
+            "python": "${workspaceFolder}/.venv/bin/python"
+        },
+        {
+            "name": "Python: Debug Tests",
+            "type": "debugpy",
+            "request": "launch",
+            "module": "pytest",
+            "args": [
+                "tests",
+                "-v",
+                "--tb=short"
+            ],
+            "console": "integratedTerminal",
+            "justMyCode": false,
+            "python": "${workspaceFolder}/.venv/bin/python"
+        },
+        {
+            "name": "Python: Debug Current Test File",
+            "type": "debugpy",
+            "request": "launch",
+            "module": "pytest",
+            "args": [
+                "${file}",
+                "-v",
+                "--tb=short"
+            ],
+            "console": "integratedTerminal",
+            "justMyCode": false,
+            "python": "${workspaceFolder}/.venv/bin/python"
+        }
+    ]
+}

uptimer_python_sdk-0.2.0/.vscode/settings.json

@@ -0,0 +1,33 @@
+{
+    "python.defaultInterpreterPath": "./.venv/bin/python",
+    "python.testing.pytestEnabled": true,
+    "python.testing.unittestEnabled": false,
+    "python.testing.nosetestsEnabled": false,
+    "python.testing.pytestArgs": [
+        "tests"
+    ],
+    "python.linting.enabled": true,
+    "python.linting.ruffEnabled": true,
+    "python.linting.pylintEnabled": false,
+    "python.linting.flake8Enabled": false,
+    "python.linting.mypyEnabled": false,
+    "python.formatting.provider": "ruff",
+    "python.formatting.ruffArgs": [],
+    "editor.formatOnSave": true,
+    "editor.codeActionsOnSave": {
+        "source.organizeImports": "explicit",
+        "source.fixAll": "explicit"
+    },
+    "files.exclude": {
+        "**/__pycache__": true,
+        "**/*.pyc": true,
+        "**/.pytest_cache": true,
+        "**/.ruff_cache": true,
+        "**/htmlcov": true,
+        "**/.coverage": true,
+        "**/.venv": false
+    },
+    "python.terminal.activateEnvironment": true,
+    "python.terminal.activateEnvInCurrentTerminal": true,
+    "python.envFile": "${workspaceFolder}/.env"
+} 

uptimer_python_sdk-0.2.0/.vscode/tasks.json

@@ -0,0 +1,131 @@
+{
+    "version": "2.0.0",
+    "tasks": [
+        {
+            "label": "Run All Tests",
+            "type": "shell",
+            "command": "uv",
+            "args": [
+                "run",
+                "python",
+                "-m",
+                "pytest"
+            ],
+            "group": "test",
+            "presentation": {
+                "echo": true,
+                "reveal": "always",
+                "focus": false,
+                "panel": "shared",
+                "showReuseMessage": true,
+                "clear": false
+            },
+            "problemMatcher": []
+        },
+        {
+            "label": "Run Tests with Coverage",
+            "type": "shell",
+            "command": "uv",
+            "args": [
+                "run",
+                "python",
+                "-m",
+                "pytest",
+                "--cov=src",
+                "--cov-report=html"
+            ],
+            "group": "test",
+            "presentation": {
+                "echo": true,
+                "reveal": "always",
+                "focus": false,
+                "panel": "shared",
+                "showReuseMessage": true,
+                "clear": false
+            },
+            "problemMatcher": []
+        },
+        {
+            "label": "Run Ruff Check",
+            "type": "shell",
+            "command": "uv",
+            "args": [
+                "run",
+                "ruff",
+                "check",
+                "."
+            ],
+            "group": "build",
+            "presentation": {
+                "echo": true,
+                "reveal": "always",
+                "focus": false,
+                "panel": "shared",
+                "showReuseMessage": true,
+                "clear": false
+            },
+            "problemMatcher": []
+        },
+        {
+            "label": "Run Ruff Format",
+            "type": "shell",
+            "command": "uv",
+            "args": [
+                "run",
+                "ruff",
+                "format",
+                "."
+            ],
+            "group": "build",
+            "presentation": {
+                "echo": true,
+                "reveal": "always",
+                "focus": false,
+                "panel": "shared",
+                "showReuseMessage": true,
+                "clear": false
+            },
+            "problemMatcher": []
+        },
+        {
+            "label": "Run Pre-commit",
+            "type": "shell",
+            "command": "uv",
+            "args": [
+                "run",
+                "pre-commit",
+                "run",
+                "--all-files"
+            ],
+            "group": "build",
+            "presentation": {
+                "echo": true,
+                "reveal": "always",
+                "focus": false,
+                "panel": "shared",
+                "showReuseMessage": true,
+                "clear": false
+            },
+            "problemMatcher": []
+        },
+        {
+            "label": "Install Dependencies",
+            "type": "shell",
+            "command": "uv",
+            "args": [
+                "sync",
+                "--dev"
+            ],
+            "group": "build",
+            "presentation": {
+                "echo": true,
+                "reveal": "always",
+                "focus": false,
+                "panel": "shared",
+                "showReuseMessage": true,
+                "clear": false
+            },
+            "problemMatcher": []
+        }
+    ]
+}

uptimer_python_sdk-0.2.0/CHANGELOG.md

@@ -0,0 +1,13 @@
+## 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/LICENSE

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

uptimer_python_sdk-0.2.0/NOTICE

@@ -0,0 +1,18 @@
+Uptimer Python SDK
+Copyright (c) 2025 myuptime.info
+
+This software includes the following third-party components:
+
+httpx
+Copyright © 2019, Encode OSS Ltd (https://www.encode.io/).
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+- Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+
+- Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+- Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

uptimer_python_sdk-0.2.0/PKG-INFO

@@ -0,0 +1,167 @@
+Metadata-Version: 2.4
+Name: uptimer-python-sdk
+Version: 0.2.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>
+License: MIT
+License-File: LICENSE
+License-File: NOTICE
+Requires-Python: >=3.9
+Requires-Dist: httpx>=0.28.1
+Description-Content-Type: text/markdown
+
+# Uptimer Python SDK
+
+A Python SDK for [uptimer](https://uptimer.myuptime.info/) - a monitoring and uptime checking service.
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+For third-party license information, see the [NOTICE](NOTICE) file.
+
+## Usage
+
+```python
+from uptimer.client import UptimerClient
+from uptimer.models.rule import CreateRuleRequest, RuleRequest, RuleResponse, RuleResponseBody
+from uptimer.errors import DefaultUptimerApiError, UptimerInvalidHttpCodeError, UptimerError
+# Initialize the client
+client = UptimerClient(
+    api_key="your-api-key-here",
+    base_url="http://127.0.0.1:2517/api",  # or your custom base URL
+)
+regions = client.v1.regions.all()
+workspaces = client.v1.workspaces.all()
+workspace_id = workspaces[0].id
+rules =client.v1.rules.all(workspace_id)
+
+new_rule = client.v1.rules.create(
+    CreateRuleRequest(
+        name="My Test Rule",
+        interval=60,  # Check every 60 seconds
+        workspace_id=workspace_id,
+        request=RuleRequest(
+            url="https://example.com",
+            method="GET",  # PATCH, POST, HEAD
+            content_type="application/json",  # expected content type
+            data="",  # data (substring) that should be contained in resonse
+        ),
+        response=RuleResponse(
+            statuses=[200, 201, 202],  # any of this status means site is up
+            body=RuleResponseBody(content="expected response"),
+        ),
+    ),
+)
+
+new_rule_updated = client.v1.rules.update(
+    new_rule.id,
+    CreateRuleRequest(
+        name="Updated Rule Name",
+        interval=120,  # Change to 2 minutes
+        workspace_id=workspace_id,
+        request=RuleRequest(
+            url="https://updated-example.com",
+            method="POST",
+            content_type="application/json",
+            data='{"key": "value"}',
+        ),
+        response=RuleResponse(
+            statuses=[200, 201],
+            body=RuleResponseBody(content="updated expected response"),
+        ),
+    ),
+)
+
+# caching errors on delete example
+try:
+  client.v1.rules.delete(new_rule_updated.id)
+except DefaultUptimerApiError as e:
+  # error responses from uptimer server
+  print(
+    e.message,  # user message
+    e.code,  # error id
+    e.error_type,  # class of error,
+    e.details,  # detailed message for a developer
+  )
+except UptimerInvalidHttpCodeError as e:
+  # uptimer api always return 200, if not -> http transport error
+  # for an example 404 status is really page (url) not found, it doesn't mean that an object with id not found.
+  print(
+    e.url,
+    e.status_code,
+  )
+except UptimerError as e: # base error, if you need one
+  raise
+```
+
+Also, check out [examples directory](https://github.com/myuptime-info/uptimer-python-sdk/examples)
+
+### Development Setup
+
+1. Clone the repository:
+
+```bash
+git clone <repository-url>
+cd uptimer-python-sdk
+```
+
+2. Install dependencies:
+
+```bash
+uv sync --dev
+# for integration tests
+uv run playwright install chromium
+```
+
+3. Run tests:
+
+```bash
+uv run pytest
+# integration
+docker pull myuptime/uptimer
+docker run -p 2517:2517 myuptime/uptimer
+UPTIMER_URL=http://localhost:2517  uv run --integration
+```
+
+4. Run linting:
+
+```bash
+uv run ruff check .
+uv run mypy src
+```
+
+5. Format code:
+
+```bash
+uv run ruff format .
+```
+
+6. Run pre-commit hooks:
+
+```bash
+uv run pre-commit run --all-files
+```
+
+## Third-Party Licenses
+
+This project uses the following third-party libraries:
+
+### Production Dependencies
+
+- **httpx** (BSD 3-Clause License) - HTTP client for Python
+
+### Development Dependencies
+
+- **mypy** (Apache 2.0 License) - Static type checker
+- **playwright** (Apache 2.0 License) - Browser automation
+- **pre-commit** (MIT License) - Git hooks framework
+- **pytest** (MIT License) - Testing framework
+- **pytest-cov** (MIT License) - Coverage plugin for pytest
+- **pytest-httpx** (MIT License) - HTTPX plugin for pytest
+- **pytest-playwright** (MIT License) - Playwright plugin for pytest
+- **responses** (Apache 2.0 License) - Mock library for requests
+- **ruff** (MIT License) - Fast Python linter and formatter
+
+All third-party licenses are compatible with the MIT License used by this project. Note that the BSD 3-Clause License (used by httpx) includes an additional restriction prohibiting the use of the copyright holder's name for endorsement without permission.