devopness 2.6.4__tar.gz → 2.7.0__tar.gz

{devopness-2.6.4 → devopness-2.7.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: devopness
-Version: 2.6.4
+Version: 2.7.0
 Summary: Devopness API Python SDK - Painless essential DevOps to everyone
 License-Expression: Apache-2.0
 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
@@ -100,7 +100,7 @@ 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)
+config = DevopnessClientConfig(base_url="https://api.devopness.com", timeout=10)
 
 devopness = DevopnessClient(config)
 devopness_async = DevopnessClientAsync(config)
@@ -152,16 +152,18 @@ import asyncio
 from devopness import DevopnessClientAsync, DevopnessClientConfig
 
 # Option 1: Pass token during initialization
-config = DevopnessClientConfig(api_token='your-personal-access-token-here')
+config = DevopnessClientConfig(api_token="your-personal-access-token-here")
 devopness = DevopnessClientAsync(config)
 
 # Option 2: Set token after initialization
 devopness = DevopnessClientAsync()
-devopness.api_token = 'your-personal-access-token-here'
+devopness.api_token = "your-personal-access-token-here"
+
 
 async def main():
     current_user = await devopness.users.get_user_me()
-    print(f'User ID: {current_user.data.id}')
+    print(f"User ID: {current_user.data.id}")
+
 
 if __name__ == "__main__":
     asyncio.run(main())
@@ -173,16 +175,18 @@ if __name__ == "__main__":
 from devopness import DevopnessClient, DevopnessClientConfig
 
 # Option 1: Pass token during initialization
-config = DevopnessClientConfig(api_token='your-personal-access-token-here')
+config = DevopnessClientConfig(api_token="your-personal-access-token-here")
 devopness = DevopnessClient(config)
 
 # Option 2: Set token after initialization
 devopness = DevopnessClient()
-devopness.api_token = 'your-personal-access-token-here'
+devopness.api_token = "your-personal-access-token-here"
+
 
 def main():
     current_user = devopness.users.get_user_me()
-    print(f'User ID: {current_user.data.id}')
+    print(f"User ID: {current_user.data.id}")
+
 
 if __name__ == "__main__":
     main()
@@ -199,11 +203,13 @@ import asyncio
 from devopness import DevopnessClientAsync
 
 devopness = DevopnessClientAsync()
-devopness.api_token = 'your-project-api-token-here'
+devopness.api_token = "your-project-api-token-here"
+
 
 async def main():
     project = await devopness.projects.get_project(project_id=123)
-    print(f'Project name: {project.data.name}')
+    print(f"Project name: {project.data.name}")
+
 
 if __name__ == "__main__":
     asyncio.run(main())
@@ -215,11 +221,13 @@ if __name__ == "__main__":
 from devopness import DevopnessClient
 
 devopness = DevopnessClient()
-devopness.api_token = 'your-project-api-token-here'
+devopness.api_token = "your-project-api-token-here"
+
 
 def main():
     project = devopness.projects.get_project(project_id=123)
-    print(f'Project name: {project.data.name}')
+    print(f"Project name: {project.data.name}")
+
 
 if __name__ == "__main__":
     main()
@@ -241,17 +249,19 @@ import os
 from devopness import DevopnessClientAsync, DevopnessClientConfig
 from devopness.core import DevopnessSdkError
 
-config = DevopnessClientConfig(api_token=os.getenv('DEVOPNESS_API_TOKEN'))
+config = DevopnessClientConfig(api_token=os.getenv("DEVOPNESS_API_TOKEN"))
 devopness = DevopnessClientAsync(config)
 
+
 async def get_user_profile():
     try:
         # Retrieve current user details
         current_user = await devopness.users.get_user_me()
-        print(f'User ID: {current_user.data.id}')
+        print(f"User ID: {current_user.data.id}")
 
     except DevopnessSdkError as error:
-        print(f'Error: {error}')
+        print(f"Error: {error}")
+
 
 if __name__ == "__main__":
     asyncio.run(get_user_profile())
@@ -264,17 +274,19 @@ import os
 from devopness import DevopnessClient, DevopnessClientConfig
 from devopness.core import DevopnessSdkError
 
-config = DevopnessClientConfig(api_token=os.getenv('DEVOPNESS_API_TOKEN'))
+config = DevopnessClientConfig(api_token=os.getenv("DEVOPNESS_API_TOKEN"))
 devopness = DevopnessClient(config)
 
+
 def get_user_profile():
     try:
         # Retrieve current user details
         current_user = devopness.users.get_user_me()
-        print(f'User ID: {current_user.data.id}')
+        print(f"User ID: {current_user.data.id}")
 
     except DevopnessSdkError as error:
-        print(f'Error: {error}')
+        print(f"Error: {error}")
+
 
 if __name__ == "__main__":
     get_user_profile()

{devopness-2.6.4 → devopness-2.7.0}/README.md

@@ -68,7 +68,7 @@ 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)
+config = DevopnessClientConfig(base_url="https://api.devopness.com", timeout=10)
 
 devopness = DevopnessClient(config)
 devopness_async = DevopnessClientAsync(config)
@@ -120,16 +120,18 @@ import asyncio
 from devopness import DevopnessClientAsync, DevopnessClientConfig
 
 # Option 1: Pass token during initialization
-config = DevopnessClientConfig(api_token='your-personal-access-token-here')
+config = DevopnessClientConfig(api_token="your-personal-access-token-here")
 devopness = DevopnessClientAsync(config)
 
 # Option 2: Set token after initialization
 devopness = DevopnessClientAsync()
-devopness.api_token = 'your-personal-access-token-here'
+devopness.api_token = "your-personal-access-token-here"
+
 
 async def main():
     current_user = await devopness.users.get_user_me()
-    print(f'User ID: {current_user.data.id}')
+    print(f"User ID: {current_user.data.id}")
+
 
 if __name__ == "__main__":
     asyncio.run(main())
@@ -141,16 +143,18 @@ if __name__ == "__main__":
 from devopness import DevopnessClient, DevopnessClientConfig
 
 # Option 1: Pass token during initialization
-config = DevopnessClientConfig(api_token='your-personal-access-token-here')
+config = DevopnessClientConfig(api_token="your-personal-access-token-here")
 devopness = DevopnessClient(config)
 
 # Option 2: Set token after initialization
 devopness = DevopnessClient()
-devopness.api_token = 'your-personal-access-token-here'
+devopness.api_token = "your-personal-access-token-here"
+
 
 def main():
     current_user = devopness.users.get_user_me()
-    print(f'User ID: {current_user.data.id}')
+    print(f"User ID: {current_user.data.id}")
+
 
 if __name__ == "__main__":
     main()
@@ -167,11 +171,13 @@ import asyncio
 from devopness import DevopnessClientAsync
 
 devopness = DevopnessClientAsync()
-devopness.api_token = 'your-project-api-token-here'
+devopness.api_token = "your-project-api-token-here"
+
 
 async def main():
     project = await devopness.projects.get_project(project_id=123)
-    print(f'Project name: {project.data.name}')
+    print(f"Project name: {project.data.name}")
+
 
 if __name__ == "__main__":
     asyncio.run(main())
@@ -183,11 +189,13 @@ if __name__ == "__main__":
 from devopness import DevopnessClient
 
 devopness = DevopnessClient()
-devopness.api_token = 'your-project-api-token-here'
+devopness.api_token = "your-project-api-token-here"
+
 
 def main():
     project = devopness.projects.get_project(project_id=123)
-    print(f'Project name: {project.data.name}')
+    print(f"Project name: {project.data.name}")
+
 
 if __name__ == "__main__":
     main()
@@ -209,17 +217,19 @@ import os
 from devopness import DevopnessClientAsync, DevopnessClientConfig
 from devopness.core import DevopnessSdkError
 
-config = DevopnessClientConfig(api_token=os.getenv('DEVOPNESS_API_TOKEN'))
+config = DevopnessClientConfig(api_token=os.getenv("DEVOPNESS_API_TOKEN"))
 devopness = DevopnessClientAsync(config)
 
+
 async def get_user_profile():
     try:
         # Retrieve current user details
         current_user = await devopness.users.get_user_me()
-        print(f'User ID: {current_user.data.id}')
+        print(f"User ID: {current_user.data.id}")
 
     except DevopnessSdkError as error:
-        print(f'Error: {error}')
+        print(f"Error: {error}")
+
 
 if __name__ == "__main__":
     asyncio.run(get_user_profile())
@@ -232,17 +242,19 @@ import os
 from devopness import DevopnessClient, DevopnessClientConfig
 from devopness.core import DevopnessSdkError
 
-config = DevopnessClientConfig(api_token=os.getenv('DEVOPNESS_API_TOKEN'))
+config = DevopnessClientConfig(api_token=os.getenv("DEVOPNESS_API_TOKEN"))
 devopness = DevopnessClient(config)
 
+
 def get_user_profile():
     try:
         # Retrieve current user details
         current_user = devopness.users.get_user_me()
-        print(f'User ID: {current_user.data.id}')
+        print(f"User ID: {current_user.data.id}")
 
     except DevopnessSdkError as error:
-        print(f'Error: {error}')
+        print(f"Error: {error}")
+
 
 if __name__ == "__main__":
     get_user_profile()

{devopness-2.6.4 → devopness-2.7.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "poetry.core.masonry.api"
 
 [project]
 name = "devopness"
-version = "2.6.4"
+version = "2.7.0"
 description = "Devopness API Python SDK - Painless essential DevOps to everyone"
 license = "Apache-2.0"
 readme = "README.md"
@@ -68,7 +68,7 @@ exclude = ["src/devopness/generated/.openapi-generator-ignore"]
 
 [tool.poetry.group.dev.dependencies]
 openapi-generator-cli = { version = "7.24.0", markers = "python_version < '4.0'" }
-ruff = "^0.15.22"
+ruff = "^0.16.2"
 mypy = "^2.3.0"
 
 [tool.ruff]
@@ -107,6 +107,7 @@ ignore = [
 "src/devopness/generated/**/*" = [
   "line-too-long",                 # Line too long
   "non-pep604-annotation-union",   # Use `X | Y` for type annotations (auto-generated code uses Union)
+  "builtin-argument-shadowing",    # Shadowing builtin argument
 ]
 "src/devopness/generated/**/__init__.py" = [
   "unused-import", # Module imported but unused

{devopness-2.6.4 → devopness-2.7.0}/src/devopness/generated/api/actions_api.py

@@ -6,8 +6,16 @@ Note:
     https://openapi-generator.tech
 """
 
+from typing import Union
+
 from .. import DevopnessBaseService, DevopnessBaseServiceAsync, DevopnessResponse
-from ..models import Action, ActionRelation, ActionRetryResponse
+from ..models import (
+    Action,
+    ActionRelation,
+    ActionRetryResponse,
+    ListActionsFilterParameter,
+    ListActionsFilterParameterPlain,
+)
 from ..utils import parse_query_string
 
 
@@ -23,6 +31,9 @@ class ActionsApiService(DevopnessBaseService):
         """
         Get an action by ID
 
+        Attributes:
+            action_id (int): The ID of the action.
+
         Raises:
             DevopnessApiError: If an API request error occurs.
             DevopnessNetworkError: If a network error occurs.
@@ -41,10 +52,17 @@ class ActionsApiService(DevopnessBaseService):
         self,
         page: int | None = None,
         per_page: int | None = None,
+        filter: Union[ListActionsFilterParameter, ListActionsFilterParameterPlain]
+        | None = None,
     ) -> DevopnessResponse[list[ActionRelation]]:
         """
         Return a list of all actions belonging to current user
 
+        Attributes:
+            page (Optional[int]): Number of the page to be retrieved
+            per_page (Optional[int]): Number of items returned per page
+            filter (Optional[Union[ListActionsFilterParameter, ListActionsFilterParameterPlain,]]): Filter the results using the available fields. Multiple filters can be combined.  Example: `?filter[resource_type]=application&filter[status]=active`
+
         Raises:
             DevopnessApiError: If an API request error occurs.
             DevopnessNetworkError: If a network error occurs.
@@ -54,12 +72,13 @@ class ActionsApiService(DevopnessBaseService):
             {
                 "page": page,
                 "per_page": per_page,
+                "filter": filter,
             }
         )
 
         endpoint_parts = [
             "/actions",
-            f"?{query_string}",
+            f"?{query_string}" if query_string else "",
         ]
 
         endpoint: str = "".join(endpoint_parts)
@@ -77,6 +96,12 @@ class ActionsApiService(DevopnessBaseService):
         """
         List resource actions of an action type
 
+        Attributes:
+            resource_id (int): The resource ID.
+            resource_type (str): The resource type to get related actions.
+            page (Optional[int]): Number of the page to be retrieved
+            per_page (Optional[int]): Number of items returned per page
+
         Raises:
             DevopnessApiError: If an API request error occurs.
             DevopnessNetworkError: If a network error occurs.
@@ -91,7 +116,7 @@ class ActionsApiService(DevopnessBaseService):
 
         endpoint_parts = [
             f"/actions/{resource_type}/{resource_id}",
-            f"?{query_string}",
+            f"?{query_string}" if query_string else "",
         ]
 
         endpoint: str = "".join(endpoint_parts)
@@ -109,6 +134,12 @@ class ActionsApiService(DevopnessBaseService):
         """
         List actions triggered to a given action target resource
 
+        Attributes:
+            target_resource_id (int): The resource ID of the action target.
+            target_resource_type (str): The resource type of the action target on which this action will be executed to perform operations on the action resource.
+            page (Optional[int]): Number of the page to be retrieved
+            per_page (Optional[int]): Number of items returned per page
+
         Raises:
             DevopnessApiError: If an API request error occurs.
             DevopnessNetworkError: If a network error occurs.
@@ -123,7 +154,7 @@ class ActionsApiService(DevopnessBaseService):
 
         endpoint_parts = [
             f"/actions/targets/{target_resource_type}/{target_resource_id}",
-            f"?{query_string}",
+            f"?{query_string}" if query_string else "",
         ]
 
         endpoint: str = "".join(endpoint_parts)
@@ -138,6 +169,9 @@ class ActionsApiService(DevopnessBaseService):
         """
         Retry an action
 
+        Attributes:
+            action_id (int): The ID of the action.
+
         Raises:
             DevopnessApiError: If an API request error occurs.
             DevopnessNetworkError: If a network error occurs.
@@ -165,6 +199,9 @@ class ActionsApiServiceAsync(DevopnessBaseServiceAsync):
         """
         Get an action by ID
 
+        Attributes:
+            action_id (int): The ID of the action.
+
         Raises:
             DevopnessApiError: If an API request error occurs.
             DevopnessNetworkError: If a network error occurs.
@@ -183,10 +220,17 @@ class ActionsApiServiceAsync(DevopnessBaseServiceAsync):
         self,
         page: int | None = None,
         per_page: int | None = None,
+        filter: Union[ListActionsFilterParameter, ListActionsFilterParameterPlain]
+        | None = None,
     ) -> DevopnessResponse[list[ActionRelation]]:
         """
         Return a list of all actions belonging to current user
 
+        Attributes:
+            page (Optional[int]): Number of the page to be retrieved
+            per_page (Optional[int]): Number of items returned per page
+            filter (Optional[Union[ListActionsFilterParameter, ListActionsFilterParameterPlain,]]): Filter the results using the available fields. Multiple filters can be combined.  Example: `?filter[resource_type]=application&filter[status]=active`
+
         Raises:
             DevopnessApiError: If an API request error occurs.
             DevopnessNetworkError: If a network error occurs.
@@ -196,12 +240,13 @@ class ActionsApiServiceAsync(DevopnessBaseServiceAsync):
             {
                 "page": page,
                 "per_page": per_page,
+                "filter": filter,
             }
         )
 
         endpoint_parts = [
             "/actions",
-            f"?{query_string}",
+            f"?{query_string}" if query_string else "",
         ]
 
         endpoint: str = "".join(endpoint_parts)
@@ -219,6 +264,12 @@ class ActionsApiServiceAsync(DevopnessBaseServiceAsync):
         """
         List resource actions of an action type
 
+        Attributes:
+            resource_id (int): The resource ID.
+            resource_type (str): The resource type to get related actions.
+            page (Optional[int]): Number of the page to be retrieved
+            per_page (Optional[int]): Number of items returned per page
+
         Raises:
             DevopnessApiError: If an API request error occurs.
             DevopnessNetworkError: If a network error occurs.
@@ -233,7 +284,7 @@ class ActionsApiServiceAsync(DevopnessBaseServiceAsync):
 
         endpoint_parts = [
             f"/actions/{resource_type}/{resource_id}",
-            f"?{query_string}",
+            f"?{query_string}" if query_string else "",
         ]
 
         endpoint: str = "".join(endpoint_parts)
@@ -251,6 +302,12 @@ class ActionsApiServiceAsync(DevopnessBaseServiceAsync):
         """
         List actions triggered to a given action target resource
 
+        Attributes:
+            target_resource_id (int): The resource ID of the action target.
+            target_resource_type (str): The resource type of the action target on which this action will be executed to perform operations on the action resource.
+            page (Optional[int]): Number of the page to be retrieved
+            per_page (Optional[int]): Number of items returned per page
+
         Raises:
             DevopnessApiError: If an API request error occurs.
             DevopnessNetworkError: If a network error occurs.
@@ -265,7 +322,7 @@ class ActionsApiServiceAsync(DevopnessBaseServiceAsync):
 
         endpoint_parts = [
             f"/actions/targets/{target_resource_type}/{target_resource_id}",
-            f"?{query_string}",
+            f"?{query_string}" if query_string else "",
         ]
 
         endpoint: str = "".join(endpoint_parts)
@@ -280,6 +337,9 @@ class ActionsApiServiceAsync(DevopnessBaseServiceAsync):
         """
         Retry an action
 
+        Attributes:
+            action_id (int): The ID of the action.
+
         Raises:
             DevopnessApiError: If an API request error occurs.
             DevopnessNetworkError: If a network error occurs.

{devopness-2.6.4 → devopness-2.7.0}/src/devopness/generated/api/actions_logs_api.py

@@ -24,6 +24,11 @@ class ActionsLogsApiService(DevopnessBaseService):
         """
         Get action target step log
 
+        Attributes:
+            action_id (int): The ID of the action.
+            action_step_order (int): The action step order.
+            action_target_id (int): The ID of the action target.
+
         Raises:
             DevopnessApiError: If an API request error occurs.
             DevopnessNetworkError: If a network error occurs.
@@ -53,6 +58,11 @@ class ActionsLogsApiServiceAsync(DevopnessBaseServiceAsync):
         """
         Get action target step log
 
+        Attributes:
+            action_id (int): The ID of the action.
+            action_step_order (int): The action step order.
+            action_target_id (int): The ID of the action target.
+
         Raises:
             DevopnessApiError: If an API request error occurs.
             DevopnessNetworkError: If a network error occurs.