devopness 0.0.0__tar.gz

devopness-0.0.0/PKG-INFO

@@ -0,0 +1,253 @@
+Metadata-Version: 2.3
+Name: devopness
+Version: 0.0.0
+Summary: Devopness API Python SDK - Painless essential DevOps to everyone
+License: MIT
+Keywords: API Client,Cloud Engineering,Cloud Infrastructure,Cloud Platform,Cloud Resource Management,Configuration Management,Deployment Automation,Devopness,DevOps,Infrastructure as Code,Platform Engineering,Python SDK,Server Management,Server Provisioning,Zero Downtime Deployment
+Author: Devopness (https://www.devopness.com)
+Requires-Python: >=3.11
+Classifier: Development Status :: 2 - Pre-Alpha
+Classifier: Environment :: Console
+Classifier: Framework :: Pydantic
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: System Administrators
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+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 :: Software Development
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: System :: Systems Administration
+Classifier: Topic :: Utilities
+Requires-Dist: httpcore (>=1.0.9)
+Requires-Dist: httpx (>=0.28.1,<0.29.0)
+Requires-Dist: pydantic (>=2.11.3,<3.0.0)
+Project-URL: Homepage, https://www.devopness.com
+Project-URL: Repository, https://github.com/devopness/devopness
+Description-Content-Type: text/markdown
+
+# Devopness SDK - Python
+
+The official Devopness SDK for Python.
+
+This SDK provides predefined classes to access Devopness platform resources. It's suitable for building CLI tools, backend services, or automation scripts, helping you interact with the Devopness API.
+
+## 📌 Table of Contents
+
+- [Status](#status)
+- [Usage](#usage)
+
+  - [Install](#install)
+  - [Initializing](#initializing)
+  - [Custom Configuration](#custom-configuration)
+  - [Authenticating](#authenticating)
+    - [Asynchronous usage](#asynchronous-usage)
+    - [Synchronous usage](#synchronous-usage)
+  - [Invoking authentication-protected endpoints](#invoking-authentication-protected-endpoints)
+    - [Asynchronous usage](#asynchronous-usage-1)
+    - [Synchronous usage](#synchronous-usage-1)
+  - [Error Handling](#error-handling)
+- [Development](#development)
+  - [With Docker](#with-docker)
+
+## Status
+
+This SDK is in active development and not recommended for production use. Features, structure, and usage may change until a stable version is released.
+
+## Usage
+
+The SDK supports both asynchronous and synchronous usage, so you can choose based on your needs.
+
+### Install
+
+Install the SDK using your preferred package manager:
+
+```bash
+# Using uv
+uv add devopness
+
+# Using poetry
+poetry add devopness
+
+# Using pip
+pip install devopness
+```
+
+### Initializing
+
+Import the SDK and create an instance of `DevopnessClient` or `DevopnessClientAsync`:
+
+```python
+from devopness import DevopnessClient, DevopnessClientAsync
+
+devopness = DevopnessClient()
+devopness_async = DevopnessClientAsync()
+```
+
+### Custom Configuration
+
+You can provide a custom configuration when initializing the client:
+
+```python
+from devopness import DevopnessClient, DevopnessClientAsync, DevopnessClientConfig
+
+config = DevopnessClientConfig(base_url='https://api.devopness.com', timeout=10)
+
+devopness = DevopnessClient(config)
+devopness_async = DevopnessClientAsync(config)
+```
+
+Configuration options:
+
+| Parameter            | Default                     | Description                                         |
+| -------------------- | --------------------------- | --------------------------------------------------- |
+| `auto_refresh_token` | `True`                      | Whether the access token is automatically refreshed |
+| `base_url`           | `https://api.devopness.com` | Base URL for all API requests                       |
+| `timeout`            | `30`                        | Timeout for HTTP requests (in seconds)              |
+| `default_encoding`   | `utf-8`                     | Encoding for response content                       |
+
+### Authenticating
+
+To authenticate, invoke the `login_user` method on the `users` service.
+
+#### Asynchronous usage
+
+```python
+import asyncio
+
+from devopness import DevopnessClientAsync
+from devopness.models import UserLogin
+
+devopness = DevopnessClientAsync({'auto_refresh_token': False})
+
+async def authenticate(user_email, user_pass):
+    user_data = UserLogin(email=user_email, password=user_pass)
+    user_tokens = await devopness.users.login_user(user_data)
+
+    # The `access_token` must be set every time a token is obtained or refreshed,
+    # if the `auto_refresh_token` option is set to `False`.
+    devopness.access_token = user_tokens.data.access_token
+
+if __name__ == "__main__":
+    asyncio.run(authenticate('user@email.com', 'secret-password'))
+```
+
+#### Synchronous usage
+
+```python
+from devopness import DevopnessClient
+from devopness.models import UserLogin
+
+devopness = DevopnessClient({'auto_refresh_token': False})
+
+def authenticate(user_email, user_pass):
+    user_data = UserLogin(email=user_email, password=user_pass)
+    user_tokens = devopness.users.login_user(user_data)
+
+    # The `access_token` must be set every time a token is obtained or refreshed,
+    # if the `auto_refresh_token` option is set to `False`.
+    devopness.access_token = user_tokens.data.access_token
+
+if __name__ == "__main__":
+    authenticate('user@email.com', 'secret-password')
+```
+
+### Invoking authentication-protected endpoints
+
+Once authenticated, you can invoke protected endpoints like retrieving user details.
+
+#### Asynchronous usage
+
+```python
+import asyncio
+
+from devopness import DevopnessClientAsync
+from devopness.models import UserLogin
+
+devopness = DevopnessClientAsync()
+
+async def authenticate(user_email, user_pass):
+    user_data = UserLogin(email=user_email, password=user_pass)
+    await devopness.users.login_user(user_data)
+
+async def get_user_profile():
+    await authenticate('user@email.com', 'secret-password')
+    current_user = await devopness.users.get_user_me()
+    print(f'User ID: {current_user.data.id}')
+
+if __name__ == "__main__":
+    asyncio.run(get_user_profile())
+```
+
+#### Synchronous usage
+
+```python
+from devopness import DevopnessClient
+from devopness.models import UserLogin
+
+devopness = DevopnessClient()
+
+def authenticate(user_email, user_pass):
+    user_data = UserLogin(email=user_email, password=user_pass)
+    devopness.users.login_user(user_data)
+
+def get_user_profile():
+    authenticate('user@email.com', 'secret-password')
+    current_user = devopness.users.get_user_me()
+    print(f'User ID: {current_user.data.id}')
+
+if __name__ == "__main__":
+    get_user_profile()
+```
+
+### Error Handling
+
+The SDK provides structured error handling through exceptions:
+
+- `DevopnessApiError`: This exception is raised when the Devopness API returns an error response. This typically indicates issues with the request itself, such as invalid input data, unauthorized access, or resource not found. It provides the following attributes to help diagnose the error:
+
+| Attribute   | Description                                                                                                        |
+| ----------- | ------------------------------------------------------------------------------------------------------------------ |
+| status_code | The HTTP status code returned by the API                                                                           |
+| message     | A general error message from the API                                                                               |
+| errors      | An optional dictionary containing detailed validation errors, often encountered during create or update operations |
+
+- `DevopnessNetworkError`: This exception is raised when a generic network-related issue occurs during the communication with the Devopness API. This could be due to problems like an unreachable host, connection timeouts, or other network configuration errors.
+
+Both exceptions inherit from `DevopnessSdkError`, the base class for all SDK exceptions. You can use this class to catch and handle all exceptions raised by the SDK.
+
+## Development
+
+To build the SDK locally, use Docker:
+
+### With Docker
+
+#### Prerequisites
+
+- [Docker](https://www.docker.com/products/docker-desktop/)
+- [Make](https://www.gnu.org/software/make/)
+
+#### Steps
+
+1. Navigate to the project directory:
+
+```shell
+cd packages/sdks/python/
+```
+
+1. Build the Docker image:
+
+```shell
+make build-image
+```
+
+1. Build the Python SDK:
+
+```shell
+make build-sdk-python
+```
+

devopness-0.0.0/README.md

@@ -0,0 +1,220 @@
+# Devopness SDK - Python
+
+The official Devopness SDK for Python.
+
+This SDK provides predefined classes to access Devopness platform resources. It's suitable for building CLI tools, backend services, or automation scripts, helping you interact with the Devopness API.
+
+## 📌 Table of Contents
+
+- [Status](#status)
+- [Usage](#usage)
+
+  - [Install](#install)
+  - [Initializing](#initializing)
+  - [Custom Configuration](#custom-configuration)
+  - [Authenticating](#authenticating)
+    - [Asynchronous usage](#asynchronous-usage)
+    - [Synchronous usage](#synchronous-usage)
+  - [Invoking authentication-protected endpoints](#invoking-authentication-protected-endpoints)
+    - [Asynchronous usage](#asynchronous-usage-1)
+    - [Synchronous usage](#synchronous-usage-1)
+  - [Error Handling](#error-handling)
+- [Development](#development)
+  - [With Docker](#with-docker)
+
+## Status
+
+This SDK is in active development and not recommended for production use. Features, structure, and usage may change until a stable version is released.
+
+## Usage
+
+The SDK supports both asynchronous and synchronous usage, so you can choose based on your needs.
+
+### Install
+
+Install the SDK using your preferred package manager:
+
+```bash
+# Using uv
+uv add devopness
+
+# Using poetry
+poetry add devopness
+
+# Using pip
+pip install devopness
+```
+
+### Initializing
+
+Import the SDK and create an instance of `DevopnessClient` or `DevopnessClientAsync`:
+
+```python
+from devopness import DevopnessClient, DevopnessClientAsync
+
+devopness = DevopnessClient()
+devopness_async = DevopnessClientAsync()
+```
+
+### Custom Configuration
+
+You can provide a custom configuration when initializing the client:
+
+```python
+from devopness import DevopnessClient, DevopnessClientAsync, DevopnessClientConfig
+
+config = DevopnessClientConfig(base_url='https://api.devopness.com', timeout=10)
+
+devopness = DevopnessClient(config)
+devopness_async = DevopnessClientAsync(config)
+```
+
+Configuration options:
+
+| Parameter            | Default                     | Description                                         |
+| -------------------- | --------------------------- | --------------------------------------------------- |
+| `auto_refresh_token` | `True`                      | Whether the access token is automatically refreshed |
+| `base_url`           | `https://api.devopness.com` | Base URL for all API requests                       |
+| `timeout`            | `30`                        | Timeout for HTTP requests (in seconds)              |
+| `default_encoding`   | `utf-8`                     | Encoding for response content                       |
+
+### Authenticating
+
+To authenticate, invoke the `login_user` method on the `users` service.
+
+#### Asynchronous usage
+
+```python
+import asyncio
+
+from devopness import DevopnessClientAsync
+from devopness.models import UserLogin
+
+devopness = DevopnessClientAsync({'auto_refresh_token': False})
+
+async def authenticate(user_email, user_pass):
+    user_data = UserLogin(email=user_email, password=user_pass)
+    user_tokens = await devopness.users.login_user(user_data)
+
+    # The `access_token` must be set every time a token is obtained or refreshed,
+    # if the `auto_refresh_token` option is set to `False`.
+    devopness.access_token = user_tokens.data.access_token
+
+if __name__ == "__main__":
+    asyncio.run(authenticate('user@email.com', 'secret-password'))
+```
+
+#### Synchronous usage
+
+```python
+from devopness import DevopnessClient
+from devopness.models import UserLogin
+
+devopness = DevopnessClient({'auto_refresh_token': False})
+
+def authenticate(user_email, user_pass):
+    user_data = UserLogin(email=user_email, password=user_pass)
+    user_tokens = devopness.users.login_user(user_data)
+
+    # The `access_token` must be set every time a token is obtained or refreshed,
+    # if the `auto_refresh_token` option is set to `False`.
+    devopness.access_token = user_tokens.data.access_token
+
+if __name__ == "__main__":
+    authenticate('user@email.com', 'secret-password')
+```
+
+### Invoking authentication-protected endpoints
+
+Once authenticated, you can invoke protected endpoints like retrieving user details.
+
+#### Asynchronous usage
+
+```python
+import asyncio
+
+from devopness import DevopnessClientAsync
+from devopness.models import UserLogin
+
+devopness = DevopnessClientAsync()
+
+async def authenticate(user_email, user_pass):
+    user_data = UserLogin(email=user_email, password=user_pass)
+    await devopness.users.login_user(user_data)
+
+async def get_user_profile():
+    await authenticate('user@email.com', 'secret-password')
+    current_user = await devopness.users.get_user_me()
+    print(f'User ID: {current_user.data.id}')
+
+if __name__ == "__main__":
+    asyncio.run(get_user_profile())
+```
+
+#### Synchronous usage
+
+```python
+from devopness import DevopnessClient
+from devopness.models import UserLogin
+
+devopness = DevopnessClient()
+
+def authenticate(user_email, user_pass):
+    user_data = UserLogin(email=user_email, password=user_pass)
+    devopness.users.login_user(user_data)
+
+def get_user_profile():
+    authenticate('user@email.com', 'secret-password')
+    current_user = devopness.users.get_user_me()
+    print(f'User ID: {current_user.data.id}')
+
+if __name__ == "__main__":
+    get_user_profile()
+```
+
+### Error Handling
+
+The SDK provides structured error handling through exceptions:
+
+- `DevopnessApiError`: This exception is raised when the Devopness API returns an error response. This typically indicates issues with the request itself, such as invalid input data, unauthorized access, or resource not found. It provides the following attributes to help diagnose the error:
+
+| Attribute   | Description                                                                                                        |
+| ----------- | ------------------------------------------------------------------------------------------------------------------ |
+| status_code | The HTTP status code returned by the API                                                                           |
+| message     | A general error message from the API                                                                               |
+| errors      | An optional dictionary containing detailed validation errors, often encountered during create or update operations |
+
+- `DevopnessNetworkError`: This exception is raised when a generic network-related issue occurs during the communication with the Devopness API. This could be due to problems like an unreachable host, connection timeouts, or other network configuration errors.
+
+Both exceptions inherit from `DevopnessSdkError`, the base class for all SDK exceptions. You can use this class to catch and handle all exceptions raised by the SDK.
+
+## Development
+
+To build the SDK locally, use Docker:
+
+### With Docker
+
+#### Prerequisites
+
+- [Docker](https://www.docker.com/products/docker-desktop/)
+- [Make](https://www.gnu.org/software/make/)
+
+#### Steps
+
+1. Navigate to the project directory:
+
+```shell
+cd packages/sdks/python/
+```
+
+1. Build the Docker image:
+
+```shell
+make build-image
+```
+
+1. Build the Python SDK:
+
+```shell
+make build-sdk-python
+```

devopness-0.0.0/pyproject.toml

@@ -0,0 +1,142 @@
+[build-system]
+requires = ["poetry-core>=2.0.0,<3.0.0"]
+build-backend = "poetry.core.masonry.api"
+
+[project]
+name = "devopness"
+version = "0.0.0"
+description = "Devopness API Python SDK - Painless essential DevOps to everyone"
+license = "MIT"
+readme = "README.md"
+requires-python = ">=3.11"
+authors = [{ name = "Devopness (https://www.devopness.com)" }]
+keywords = [
+  "API Client",
+  "Cloud Engineering",
+  "Cloud Infrastructure",
+  "Cloud Platform",
+  "Cloud Resource Management",
+  "Configuration Management",
+  "Deployment Automation",
+  "Devopness",
+  "DevOps",
+  "Infrastructure as Code",
+  "Platform Engineering",
+  "Python SDK",
+  "Server Management",
+  "Server Provisioning",
+  "Zero Downtime Deployment",
+]
+classifiers = [
+  "Development Status :: 2 - Pre-Alpha",
+  "Environment :: Console",
+  "Framework :: Pydantic",
+  "Intended Audience :: Developers",
+  "Intended Audience :: System Administrators",
+  "License :: OSI Approved :: MIT License",
+  "Operating System :: OS Independent",
+  "Programming Language :: Python",
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: 3.13",
+  "Topic :: Software Development",
+  "Topic :: Software Development :: Libraries",
+  "Topic :: Software Development :: Libraries :: Python Modules",
+  "Topic :: System :: Systems Administration",
+  "Topic :: Utilities",
+]
+dependencies = [
+  # Explicitly added `httpcore` to ensure a secure version of h11 is used.
+  # httpcore is a transitive dependency of httpx (which allows any 1.*),
+  # but only httpcore >=1.0.9 guarantees h11 >=0.16 with the security fix.
+  # Related issue: https://github.com/devopness/devopness/security/dependabot/63
+  "httpcore (>=1.0.9)",
+  "httpx (>=0.28.1,<0.29.0)",
+  "pydantic (>=2.11.3,<3.0.0)",
+]
+
+[project.urls]
+homepage = "https://www.devopness.com"
+repository = "https://github.com/devopness/devopness"
+
+[tool.poetry]
+packages = [
+  { include = "devopness", from = "src", to = "." },
+]
+exclude = ["src/devopness/generated/.openapi-generator-ignore"]
+
+[tool.poetry.group.dev.dependencies]
+openapi-generator-cli = { version = "7.12.0", markers = "python_version < '4.0'" }
+ruff = "^0.11.6"
+mypy = "1.15.0"
+
+[tool.ruff]
+line-length = 88
+target-version = "py311"
+
+[tool.ruff.lint]
+preview = true
+
+extend-select = [
+  "A",   # flake8-builtins (avoid shadowing built-ins)
+  "ANN", # flake8-annotations (type hints for public APIs)
+  "B",   # flake8-bugbear (common bugs and best practices)
+  "E",   # pycodestyle (error)
+  "F",   # pyflakes (basic errors)
+  "I",   # isort (import sorting)
+  "N",   # pep8-naming
+  "PIE", # flake8-pie (extra cleanups)
+  "PLC", # pylint conventions
+  "PLE", # pylint errors
+  "PLW", # pylint warnings
+  "Q",   # flake8-quotes (quote consistency)
+  "RET", # flake8-return (return statement rules)
+  "RUF", # Ruff-specific rules
+  "S",   # flake8-bandit (security rules)
+  "SIM", # flake8-simplify
+  "W",   # pycodestyle (warning)
+]
+
+ignore = [
+  "PLC2701", # Private name import `*` from external module `*`
+  "RET504",  # Unnecessary assignment to `**kwargs` before `return` statement
+]
+
+[tool.ruff.lint.per-file-ignores]
+"src/devopness/generated/**/*" = [
+  "E501", # Line too long
+]
+"src/devopness/generated/**/__init__.py" = [
+  "F401", # Module imported but unused
+]
+"scripts/**/*" = [
+  "ANN",  # flake8-annotations
+  "S404", # `subprocess` module is possibly insecure
+  "S602", # `subprocess` call with `shell=True` identified, security issue
+]
+"tests/**/*" = [
+  "ANN",  # flake8-annotations
+  "E501", # Line too long
+  "S101", # Use of `assert` detected
+]
+
+[tool.ruff.lint.isort]
+known-first-party = ["devopness"]
+case-sensitive = true
+
+[tool.mypy]
+python_version = "3.11"
+
+strict = true
+disallow_any_unimported = true
+strict_optional = true
+warn_no_return = true
+warn_unreachable = true
+
+sqlite_cache = true
+cache_fine_grained = true
+
+[[tool.mypy.overrides]]
+module = "devopness.generated.api.*"
+disable_error_code = ["attr-defined"]

devopness-0.0.0/src/devopness/__init__.py

@@ -0,0 +1,12 @@
+"""
+Devopness API Python SDK - Painless essential DevOps to everyone
+"""
+
+from .client import DevopnessClient, DevopnessClientAsync
+from .client_config import DevopnessClientConfig
+
+__all__ = [
+    "DevopnessClient",
+    "DevopnessClientAsync",
+    "DevopnessClientConfig",
+]

devopness-0.0.0/src/devopness/base/__init__.py

@@ -0,0 +1,12 @@
+"""
+Devopness API Python SDK - Painless essential DevOps to everyone
+"""
+
+from .base_model import DevopnessBaseModel
+from .base_service import DevopnessBaseService, DevopnessBaseServiceAsync
+
+__all__ = [
+    "DevopnessBaseModel",
+    "DevopnessBaseService",
+    "DevopnessBaseServiceAsync",
+]