devopness 2.6.3__tar.gz → 2.6.4__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: devopness
-Version: 2.6.3
+Version: 2.6.4
 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

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

@@ -4,7 +4,7 @@ build-backend = "poetry.core.masonry.api"
 
 [project]
 name = "devopness"
-version = "2.6.3"
+version = "2.6.4"
 description = "Devopness API Python SDK - Painless essential DevOps to everyone"
 license = "Apache-2.0"
 readme = "README.md"

{devopness-2.6.3 → devopness-2.6.4}/src/devopness/generated/api/applications_api.py

@@ -11,6 +11,9 @@ from typing import Union
 from .. import DevopnessBaseService, DevopnessBaseServiceAsync, DevopnessResponse
 from ..models import (
     Application,
+    ApplicationApplyTemplateResponse,
+    ApplicationEnvironmentApplyTemplate,
+    ApplicationEnvironmentApplyTemplatePlain,
     ApplicationEnvironmentCreate,
     ApplicationEnvironmentCreatePlain,
     ApplicationRelation,
@@ -61,7 +64,7 @@ class ApplicationsApiService(DevopnessBaseService):
         ],
     ) -> DevopnessResponse[Application]:
         """
-        Create a new application
+        Create an application
 
         Raises:
             DevopnessApiError: If an API request error occurs.
@@ -77,6 +80,31 @@ class ApplicationsApiService(DevopnessBaseService):
 
         return DevopnessResponse(response, Application)
 
+    def apply_template_environment_application(
+        self,
+        environment_id: int,
+        application_environment_apply_template: Union[
+            ApplicationEnvironmentApplyTemplate,
+            ApplicationEnvironmentApplyTemplatePlain,
+        ],
+    ) -> DevopnessResponse[ApplicationApplyTemplateResponse]:
+        """
+        Create applications from a template
+
+        Raises:
+            DevopnessApiError: If an API request error occurs.
+            DevopnessNetworkError: If a network error occurs.
+        """
+
+        endpoint_parts = [
+            f"/environments/{environment_id}/applications/apply-template",
+        ]
+
+        endpoint: str = "".join(endpoint_parts)
+        response = self._post(endpoint, application_environment_apply_template)
+
+        return DevopnessResponse(response, ApplicationApplyTemplateResponse)
+
     def delete_application(
         self,
         application_id: int,
@@ -126,7 +154,7 @@ class ApplicationsApiService(DevopnessBaseService):
         per_page: int | None = None,
     ) -> DevopnessResponse[list[ApplicationRelation]]:
         """
-        Return a list of all Applications belonging to an environment
+        List applications in an environment
 
         Raises:
             DevopnessApiError: If an API request error occurs.
@@ -215,7 +243,7 @@ class ApplicationsApiServiceAsync(DevopnessBaseServiceAsync):
         ],
     ) -> DevopnessResponse[Application]:
         """
-        Create a new application
+        Create an application
 
         Raises:
             DevopnessApiError: If an API request error occurs.
@@ -231,6 +259,33 @@ class ApplicationsApiServiceAsync(DevopnessBaseServiceAsync):
 
         return await DevopnessResponse.from_async(response, Application)
 
+    async def apply_template_environment_application(
+        self,
+        environment_id: int,
+        application_environment_apply_template: Union[
+            ApplicationEnvironmentApplyTemplate,
+            ApplicationEnvironmentApplyTemplatePlain,
+        ],
+    ) -> DevopnessResponse[ApplicationApplyTemplateResponse]:
+        """
+        Create applications from a template
+
+        Raises:
+            DevopnessApiError: If an API request error occurs.
+            DevopnessNetworkError: If a network error occurs.
+        """
+
+        endpoint_parts = [
+            f"/environments/{environment_id}/applications/apply-template",
+        ]
+
+        endpoint: str = "".join(endpoint_parts)
+        response = await self._post(endpoint, application_environment_apply_template)
+
+        return await DevopnessResponse.from_async(
+            response, ApplicationApplyTemplateResponse
+        )
+
     async def delete_application(
         self,
         application_id: int,
@@ -280,7 +335,7 @@ class ApplicationsApiServiceAsync(DevopnessBaseServiceAsync):
         per_page: int | None = None,
     ) -> DevopnessResponse[list[ApplicationRelation]]:
         """
-        Return a list of all Applications belonging to an environment
+        List applications in an environment
 
         Raises:
             DevopnessApiError: If an API request error occurs.

{devopness-2.6.3 → devopness-2.6.4}/src/devopness/generated/models/__init__.py

@@ -68,6 +68,14 @@ from .api_token_status import ApiTokenStatus, ApiTokenStatusPlain
 from .api_token_type import ApiTokenType, ApiTokenTypePlain
 from .api_token_type_prefix import ApiTokenTypePrefix, ApiTokenTypePrefixPlain
 from .application import Application, ApplicationPlain
+from .application_apply_template_response import (
+    ApplicationApplyTemplateResponse,
+    ApplicationApplyTemplateResponsePlain,
+)
+from .application_environment_apply_template import (
+    ApplicationEnvironmentApplyTemplate,
+    ApplicationEnvironmentApplyTemplatePlain,
+)
 from .application_environment_create import (
     ApplicationEnvironmentCreate,
     ApplicationEnvironmentCreatePlain,
@@ -746,6 +754,10 @@ __all__ = [
     "ApiTokenTypePrefix",
     "ApiTokenTypePrefixPlain",
     "Application",
+    "ApplicationApplyTemplateResponse",
+    "ApplicationApplyTemplateResponsePlain",
+    "ApplicationEnvironmentApplyTemplate",
+    "ApplicationEnvironmentApplyTemplatePlain",
     "ApplicationEnvironmentCreate",
     "ApplicationEnvironmentCreatePlain",
     "ApplicationLastDeployments",

devopness-2.6.4/src/devopness/generated/models/application_apply_template_response.py

@@ -0,0 +1,232 @@
+"""
+Devopness API Python SDK - Painless essential DevOps to everyone
+
+Note:
+    This is auto generated by OpenAPI Generator.
+    https://openapi-generator.tech
+"""
+
+from typing import (
+    Required,
+    TypedDict,
+    Union,
+)
+
+from pydantic import Field, StrictInt, StrictStr
+
+from .. import DevopnessBaseModel
+from .application_last_deployments import (
+    ApplicationLastDeployments,
+    ApplicationLastDeploymentsPlain,
+)
+from .credential_relation import CredentialRelation, CredentialRelationPlain
+from .cron_job_relation import CronJobRelation, CronJobRelationPlain
+from .daemon_relation import DaemonRelation, DaemonRelationPlain
+from .environment_relation import EnvironmentRelation, EnvironmentRelationPlain
+from .server_relation import ServerRelation, ServerRelationPlain
+from .service_relation import ServiceRelation, ServiceRelationPlain
+from .user_relation import UserRelation, UserRelationPlain
+from .virtual_host_relation import VirtualHostRelation, VirtualHostRelationPlain
+
+
+class ApplicationApplyTemplateResponse(DevopnessBaseModel):
+    """
+    ApplicationApplyTemplateResponse
+
+    Attributes:
+        id (int): Unique ID of the application
+        project_id (int): Numeric ID of the project to which the application belongs to
+        environment_id (int): Numeric ID of the environment to which the application belongs to
+        created_by (int): The id of the user who created the application and to whom the application belongs
+        name (str): The application's unique name
+        repository (str): The full name of a repository (`repository_owner/repository_name`) containing the application source code.
+        repository_name (str): The name part of a repository full name (`repository_owner/repository_name`)
+        repository_owner (str): The owner part of a repository full name (`repository_owner/repository_name`)
+        default_branch (str): The version control branch that, by default, will be used when a deployment is triggered and no other branch name is informed.
+        programming_language (str): The programming language runtime environment to be used to serve the application. E.g.: if a front-end web app is developed using Node.js, but should be served statically (a SPA application, for instance) then this field value should be `html`.
+        programming_language_human_readable (str): The human readable version of the programming language of the application.
+        engine_version (str): The language runtime engine version to be used to execute this application on the deployed servers
+        framework (str): The base framework on top of which the application has been implemented - it might have impact on the steps to be performed during application deployment
+        framework_human_readable (str): The human readable version of the framework of the application.
+        root_directory (str): The relative directory where package manager's manifest files (`package.json`, `composer.json`, `yarn.lock`, etc) are located. It needs to be set for applications where the actual source code is not located in the top level directory of the repository.
+        deployments_keep (int): The number of deployment history, logs and artifacts to keep stored in both devopness servers and user's servers. OR The number of deployment artifacts to be retained in the user's servers, making it easier and faster to rollback to previous versions
+        install_dependencies_command (str, optional, nullable): Indicates command that Devopness must execute to install application dependencies
+        build_command (str, optional, nullable): The optional command that should be executed once during deployment to build the source code and get the application in a ready state
+        created_by_user (UserRelation, optional, nullable):
+        last_deployments (ApplicationLastDeployments):
+        environment (EnvironmentRelation, optional, nullable):
+        servers (List[ServerRelation]):
+        credential (CredentialRelation, optional, nullable):
+        services (List[ServiceRelation]):
+        cronjobs (List[CronJobRelation]):
+        virtual_hosts (List[VirtualHostRelation]):
+        daemons (List[DaemonRelation]):
+        created_at (str): The date and time when the record was created
+        updated_at (str): The date and time when the record was last updated
+    """
+
+    id: StrictInt = Field(
+        description="Unique ID of the application",
+        json_schema_extra={"examples": [4654019]},
+    )
+    project_id: StrictInt = Field(
+        description="Numeric ID of the project to which the application belongs to",
+        json_schema_extra={"examples": [4654019]},
+    )
+    environment_id: StrictInt = Field(
+        description="Numeric ID of the environment to which the application belongs to",
+        json_schema_extra={"examples": [4654121]},
+    )
+    created_by: StrictInt = Field(
+        description="The id of the user who created the application and to whom the application belongs",
+        json_schema_extra={"examples": [1]},
+    )
+    name: StrictStr = Field(
+        description="The application's unique name",
+        json_schema_extra={"examples": ["my-awesome-app"]},
+    )
+    repository: StrictStr = Field(
+        description="The full name of a repository (`repository_owner/repository_name`) containing the application source code.",
+        json_schema_extra={"examples": ["devopness/devopness"]},
+    )
+    repository_name: StrictStr = Field(
+        description="The name part of a repository full name (`repository_owner/repository_name`)",
+        json_schema_extra={"examples": ["devopness"]},
+    )
+    repository_owner: StrictStr = Field(
+        description="The owner part of a repository full name (`repository_owner/repository_name`)",
+        json_schema_extra={"examples": ["devopness"]},
+    )
+    default_branch: StrictStr = Field(
+        description="The version control branch that, by default, will be used when a deployment is triggered and no other branch name is informed.",
+        json_schema_extra={"examples": ["main"]},
+    )
+    programming_language: StrictStr = Field(
+        description="The programming language runtime environment to be used to serve the application. E.g.: if a front-end web app is developed using Node.js, but should be served statically (a SPA application, for instance) then this field value should be `html`.",
+        json_schema_extra={"examples": ["python"]},
+    )
+    programming_language_human_readable: StrictStr = Field(
+        description="The human readable version of the programming language of the application.",
+        json_schema_extra={"examples": ["Python"]},
+    )
+    engine_version: StrictStr = Field(
+        description="The language runtime engine version to be used to execute this application on the deployed servers",
+        json_schema_extra={"examples": ["19.03.2"]},
+    )
+    framework: StrictStr = Field(
+        description="The base framework on top of which the application has been implemented - it might have impact on the steps to be performed during application deployment",
+        json_schema_extra={"examples": ["fastapi"]},
+    )
+    framework_human_readable: StrictStr = Field(
+        description="The human readable version of the framework of the application.",
+        json_schema_extra={"examples": ["FastAPI"]},
+    )
+    root_directory: StrictStr = Field(
+        description="The relative directory where package manager's manifest files (`package.json`, `composer.json`, `yarn.lock`, etc) are located. It needs to be set for applications where the actual source code is not located in the top level directory of the repository.",
+        json_schema_extra={"examples": ["/src"]},
+    )
+    deployments_keep: StrictInt = Field(
+        description="The number of deployment history, logs and artifacts to keep stored in both devopness servers and user's servers. OR The number of deployment artifacts to be retained in the user's servers, making it easier and faster to rollback to previous versions",
+        json_schema_extra={"examples": [4]},
+    )
+    install_dependencies_command: StrictStr | None = Field(
+        description="Indicates command that Devopness must execute to install application dependencies",
+        json_schema_extra={"examples": ["npm install"]},
+    )
+    build_command: StrictStr | None = Field(
+        description="The optional command that should be executed once during deployment to build the source code and get the application in a ready state",
+        json_schema_extra={"examples": ["npm run build"]},
+    )
+    created_by_user: UserRelation | None
+    last_deployments: ApplicationLastDeployments
+    environment: EnvironmentRelation | None
+    servers: list[ServerRelation | None]
+    credential: CredentialRelation | None
+    services: list[ServiceRelation | None]
+    cronjobs: list[CronJobRelation | None]
+    virtual_hosts: list[VirtualHostRelation | None]
+    daemons: list[DaemonRelation | None]
+    created_at: StrictStr = Field(
+        description="The date and time when the record was created",
+        json_schema_extra={"examples": ["2019-09-25T15:50:48.000000Z"]},
+    )
+    updated_at: StrictStr = Field(
+        description="The date and time when the record was last updated",
+        json_schema_extra={"examples": ["2019-09-25T13:52:04.000000Z"]},
+    )
+
+
+class ApplicationApplyTemplateResponsePlain(TypedDict, total=False):
+    """
+    Plain version of ApplicationApplyTemplateResponse.
+    """
+
+    id: Required[int]
+    project_id: Required[int]
+    environment_id: Required[int]
+    created_by: Required[int]
+    name: Required[str]
+    repository: Required[str]
+    repository_name: Required[str]
+    repository_owner: Required[str]
+    default_branch: Required[str]
+    programming_language: Required[str]
+    programming_language_human_readable: Required[str]
+    engine_version: Required[str]
+    framework: Required[str]
+    framework_human_readable: Required[str]
+    root_directory: Required[str]
+    deployments_keep: Required[int]
+    install_dependencies_command: str | None
+    build_command: str | None
+    created_by_user: Union[UserRelation, UserRelationPlain] | None
+    last_deployments: Required[
+        Union[
+            ApplicationLastDeployments,
+            ApplicationLastDeploymentsPlain,
+        ]
+    ]
+    environment: Union[EnvironmentRelation, EnvironmentRelationPlain] | None
+    servers: Required[
+        list[
+            Union[
+                ServerRelation,
+                ServerRelationPlain,
+            ]
+        ]
+    ]
+    credential: Union[CredentialRelation, CredentialRelationPlain] | None
+    services: Required[
+        list[
+            Union[
+                ServiceRelation,
+                ServiceRelationPlain,
+            ]
+        ]
+    ]
+    cronjobs: Required[
+        list[
+            Union[
+                CronJobRelation,
+                CronJobRelationPlain,
+            ]
+        ]
+    ]
+    virtual_hosts: Required[
+        list[
+            Union[
+                VirtualHostRelation,
+                VirtualHostRelationPlain,
+            ]
+        ]
+    ]
+    daemons: Required[
+        list[
+            Union[
+                DaemonRelation,
+                DaemonRelationPlain,
+            ]
+        ]
+    ]
+    created_at: Required[str]
+    updated_at: Required[str]

devopness-2.6.4/src/devopness/generated/models/application_environment_apply_template.py

@@ -0,0 +1,44 @@
+"""
+Devopness API Python SDK - Painless essential DevOps to everyone
+
+Note:
+    This is auto generated by OpenAPI Generator.
+    https://openapi-generator.tech
+"""
+
+from typing import (
+    Any,
+    Required,
+    TypedDict,
+)
+
+from pydantic import Field, StrictStr
+
+from .. import DevopnessBaseModel
+
+
+class ApplicationEnvironmentApplyTemplate(DevopnessBaseModel):
+    """
+    ApplicationEnvironmentApplyTemplate
+
+    Attributes:
+        template (str): Template to use when creating the application group.
+        template_inputs (Dict[str, object]): Key/value pairs used to fill template placeholders before an application is created. Each template decides which inputs it accepts.
+    """
+
+    template: StrictStr = Field(
+        description="Template to use when creating the application group.",
+        json_schema_extra={"examples": ["n8n"]},
+    )
+    template_inputs: dict[str, Any] = Field(
+        description="Key/value pairs used to fill template placeholders before an application is created. Each template decides which inputs it accepts."
+    )
+
+
+class ApplicationEnvironmentApplyTemplatePlain(TypedDict, total=False):
+    """
+    Plain version of ApplicationEnvironmentApplyTemplate.
+    """
+
+    template: Required[str]
+    template_inputs: Required[dict[str, object]]

{devopness-2.6.3 → devopness-2.6.4}/src/devopness/generated/models/application_environment_create.py

@@ -7,7 +7,6 @@ Note:
 """
 
 from typing import (
-    Any,
     Required,
     TypedDict,
     Union,
@@ -32,12 +31,10 @@ class ApplicationEnvironmentCreate(DevopnessBaseModel):
         programming_language (str): The programming language runtime environment to be used to serve the application. E.g.: if a front-end web app is developed using Node.js, but should be served statically (a SPA application, for instance) then this field value should be `html`. Must not be greater than 30 characters.
         repository (str): The full name of a repository (`repository_owner/repository_name`) containing the application source code. Must not be greater than 100 characters.
         credential_id (int): Numeric ID of the credential to source provider where the repository is hosted.
-        root_directory (str, optional): The relative directory where package manager's manifest files (`package.json`, `composer.json`, `yarn.lock`, etc) are located. It needs to be set for applications where the actual source code is not located in the top level directory of the repository. Must start with one of <code>/</code>.
+        root_directory (str, optional): The relative directory where package manager's manifest files (`package.json`, `composer.json`, `yarn.lock`, etc) are located. It needs to be set for applications where the actual source code is not located in the top level directory of the repository. Must start with one of <code>/</code> Must not be greater than 255 characters.
         default_branch (str): The version control branch that, by default, will be used when a deployment is triggered and no other branch name is informed. Must not be greater than 200 characters.
         deployments_keep (int, optional): The number of deployment history, logs and artifacts to keep stored in both devopness servers and user's servers. OR The number of deployment artifacts to be retained in the user's servers, making it easier and faster to rollback to previous versions. Must be at least 1. Must not be greater than 10.
         install_dependencies_command (str, optional): Indicates command that Devopness must execute to install application dependencies.
-        template (str, optional): Optional template to use when creating the application. Leave empty to create the application directly without using a template.
-        template_inputs (Dict[str, object], optional): Key/value pairs used to fill template placeholders before an application is created. Each template decides which inputs it accepts.
     """
 
     linked_resources: list[ResourceToBeLinked] | None = Field(
@@ -78,7 +75,7 @@ class ApplicationEnvironmentCreate(DevopnessBaseModel):
     )
     root_directory: StrictStr | None = Field(
         default=None,
-        description="The relative directory where package manager's manifest files (`package.json`, `composer.json`, `yarn.lock`, etc) are located. It needs to be set for applications where the actual source code is not located in the top level directory of the repository. Must start with one of <code>/</code>.",
+        description="The relative directory where package manager's manifest files (`package.json`, `composer.json`, `yarn.lock`, etc) are located. It needs to be set for applications where the actual source code is not located in the top level directory of the repository. Must start with one of <code>/</code> Must not be greater than 255 characters.",
         json_schema_extra={"examples": ["/src"]},
     )
     default_branch: StrictStr = Field(
@@ -95,15 +92,6 @@ class ApplicationEnvironmentCreate(DevopnessBaseModel):
         description="Indicates command that Devopness must execute to install application dependencies.",
         json_schema_extra={"examples": ["npm install"]},
     )
-    template: StrictStr | None = Field(
-        default=None,
-        description="Optional template to use when creating the application. Leave empty to create the application directly without using a template.",
-        json_schema_extra={"examples": ["n8n"]},
-    )
-    template_inputs: dict[str, Any] | None = Field(
-        default=None,
-        description="Key/value pairs used to fill template placeholders before an application is created. Each template decides which inputs it accepts.",
-    )
 
 
 class ApplicationEnvironmentCreatePlain(TypedDict, total=False):
@@ -123,5 +111,3 @@ class ApplicationEnvironmentCreatePlain(TypedDict, total=False):
     default_branch: Required[str]
     deployments_keep: int | None
     install_dependencies_command: str | None
-    template: str | None
-    template_inputs: dict[str, object] | None

{devopness-2.6.3 → devopness-2.6.4}/src/devopness/generated/models/application_update.py

@@ -29,7 +29,7 @@ class ApplicationUpdate(DevopnessBaseModel):
         programming_language (str): The programming language runtime environment to be used to serve the application. E.g.: if a front-end web app is developed using Node.js, but should be served statically (a SPA application, for instance) then this field value should be `html`. Must not be greater than 30 characters.
         repository (str, optional): The full name of a repository (`repository_owner/repository_name`) containing the application source code. Must not be greater than 100 characters.
         credential_id (int, optional): Numeric ID of the credential to source provider where the repository is hosted. This field is required when <code>repository</code> is present.
-        root_directory (str, optional): The relative directory where package manager's manifest files (`package.json`, `composer.json`, `yarn.lock`, etc) are located. It needs to be set for applications where the actual source code is not located in the top level directory of the repository. Must start with one of <code>/</code>.
+        root_directory (str, optional): The relative directory where package manager's manifest files (`package.json`, `composer.json`, `yarn.lock`, etc) are located. It needs to be set for applications where the actual source code is not located in the top level directory of the repository. Must start with one of <code>/</code> Must not be greater than 255 characters.
         default_branch (str): The version control branch that, by default, will be used when a deployment is triggered and no other branch name is informed. Must not be greater than 200 characters.
         deployments_keep (int, optional): The number of deployment history, logs and artifacts to keep stored in both devopness servers and user's servers. OR The number of deployment artifacts to be retained in the user's servers, making it easier and faster to rollback to previous versions. Must be at least 1. Must not be greater than 10.
         install_dependencies_command (str, optional): Indicates command that Devopness must execute to install application dependencies.
@@ -76,7 +76,7 @@ class ApplicationUpdate(DevopnessBaseModel):
     )
     root_directory: StrictStr | None = Field(
         default=None,
-        description="The relative directory where package manager's manifest files (`package.json`, `composer.json`, `yarn.lock`, etc) are located. It needs to be set for applications where the actual source code is not located in the top level directory of the repository. Must start with one of <code>/</code>.",
+        description="The relative directory where package manager's manifest files (`package.json`, `composer.json`, `yarn.lock`, etc) are located. It needs to be set for applications where the actual source code is not located in the top level directory of the repository. Must start with one of <code>/</code> Must not be greater than 255 characters.",
         json_schema_extra={"examples": ["/src"]},
     )
     default_branch: StrictStr = Field(

{devopness-2.6.3 → devopness-2.6.4}/src/devopness/models.py

@@ -78,6 +78,10 @@ from .generated.models import (
     ApiTokenTypePrefix,
     ApiTokenTypePrefixPlain,
     Application,
+    ApplicationApplyTemplateResponse,
+    ApplicationApplyTemplateResponsePlain,
+    ApplicationEnvironmentApplyTemplate,
+    ApplicationEnvironmentApplyTemplatePlain,
     ApplicationEnvironmentCreate,
     ApplicationEnvironmentCreatePlain,
     ApplicationLastDeployments,
@@ -795,6 +799,10 @@ __all__ = [
     "ApiTokenTypePrefix",
     "ApiTokenTypePrefixPlain",
     "Application",
+    "ApplicationApplyTemplateResponse",
+    "ApplicationApplyTemplateResponsePlain",
+    "ApplicationEnvironmentApplyTemplate",
+    "ApplicationEnvironmentApplyTemplatePlain",
     "ApplicationEnvironmentCreate",
     "ApplicationEnvironmentCreatePlain",
     "ApplicationLastDeployments",