amsdal 0.1.26__cp311-cp311-macosx_10_9_universal2.whl → 0.2.0__cp311-cp311-macosx_10_9_universal2.whl

amsdal/__about__.py

@@ -1,4 +1,4 @@
 # SPDX-FileCopyrightText: 2023-present
 #
 # SPDX-License-Identifier: AMSDAL End User License Agreement
-__version__ = '0.1.26'
+__version__ = '0.2.0'

amsdal/cloud/client.pyi

@@ -4,10 +4,54 @@ from amsdal.errors import AmsdalAuthConnectionError as AmsdalAuthConnectionError
 from typing import Any, Protocol
 
 class HttpFunction(Protocol):
+    """
+    Protocol for HTTP function callables.
+
+    This protocol defines the structure for callables that perform HTTP requests, ensuring they accept a URL and
+        additional keyword arguments.
+    """
     def __call__(self, url: str, **kwargs: Any) -> httpx.Response: ...
 
 class AuthClientService:
+    """
+    Service to handle HTTP requests for authentication.
+
+    This class provides functionality to perform HTTP GET and POST requests to the authentication server,
+    handling connection errors and setting default timeouts.
+    """
     DEFAULT_TIMEOUT: int
     def _default_handler(self, calling_function: HttpFunction, path: str, **kwargs: Any) -> httpx.Response: ...
-    def post(self, path: str, **kwargs: Any) -> httpx.Response: ...
-    def get(self, path: str, **kwargs: Any) -> httpx.Response: ...
+    def post(self, path: str, **kwargs: Any) -> httpx.Response:
+        """
+        Sends an HTTP POST request to the specified path.
+
+        This method constructs the full URL using the base authentication URL and the provided path,
+        sets a default timeout, and sends an HTTP POST request.
+
+        Args:
+            path (str): The path to append to the base authentication URL.
+            **kwargs (Any): Additional keyword arguments to pass to the `httpx.post` function.
+
+        Returns:
+            httpx.Response: The response from the HTTP POST request.
+
+        Raises:
+            AmsdalAuthConnectionError: If there is a connection error.
+        """
+    def get(self, path: str, **kwargs: Any) -> httpx.Response:
+        """
+        Sends an HTTP GET request to the specified path.
+
+        This method constructs the full URL using the base authentication URL and the provided path,
+        sets a default timeout, and sends an HTTP GET request.
+
+        Args:
+            path (str): The path to append to the base authentication URL.
+            **kwargs (Any): Additional keyword arguments to pass to the `httpx.get` function.
+
+        Returns:
+            httpx.Response: The response from the HTTP GET request.
+
+        Raises:
+            AmsdalAuthConnectionError: If there is a connection error.
+        """

amsdal/cloud/enums.pyi

@@ -1,22 +1,68 @@
 from enum import Enum
 
 class AuthType(Enum):
+    """
+    Enumeration for authentication types.
+
+    This enum defines the types of authentication methods available.
+
+    Attributes:
+        CREDENTIALS: Authentication using credentials.
+        TOKEN: Authentication using a token.
+    """
     CREDENTIALS = ...
     TOKEN = ...
 
 class DeployType(str, Enum):
+    """
+    Enumeration for deployment types.
+
+    This enum defines the types of deployment methods available.
+
+    Attributes:
+        lakehouse_only: Deployment only to the lakehouse.
+        include_state_db: Deployment including the state database.
+    """
     lakehouse_only = 'lakehouse_only'
     include_state_db = 'include_state_db'
 
 class StateOption(str, Enum):
+    """
+    Enumeration for state options.
+
+    This enum defines the types of state database options available.
+
+    Attributes:
+        sqlite: State database using SQLite.
+        postgres: State database using PostgreSQL.
+    """
     sqlite = 'sqlite'
     postgres = 'postgres'
 
 class LakehouseOption(str, Enum):
+    """
+    Enumeration for lakehouse options.
+
+    This enum defines the types of lakehouse options available.
+
+    Attributes:
+        spark: Lakehouse option using Spark.
+        postgres: Lakehouse option using PostgreSQL.
+        postgres_immutable: Lakehouse option using immutable PostgreSQL.
+    """
     spark = 'spark'
     postgres = 'postgres'
     postgres_immutable = 'postgres-immutable'
 
 class ResponseStatus(str, Enum):
+    """
+    Enumeration for response statuses.
+
+    This enum defines the types of response statuses available.
+
+    Attributes:
+        success: Indicates a successful response.
+        error: Indicates an error response.
+    """
     success = 'success'
     error = 'error'

amsdal/cloud/models/base.pyi

@@ -3,10 +3,31 @@ from pydantic import BaseModel
 from typing import Any
 
 class ResponseBaseModel(BaseModel):
+    """
+    Base model for responses.
+
+    Attributes:
+        status (ResponseStatus): The status of the response.
+        errors (list[str] | None): A list of error messages, if any.
+    """
     status: ResponseStatus
     errors: list[str] | None
 
 class DeployResponse(BaseModel):
+    """
+    Model representing a deployment response.
+
+    Attributes:
+        status (str): The status of the deployment.
+        client_id (str): The client ID associated with the deployment.
+        deployment_id (str): The unique identifier for the deployment.
+        created_at (float): The timestamp when the deployment was created.
+        last_update_at (float): The timestamp of the last update to the deployment.
+        environment_name (str | None): The name of the environment, if any.
+        application_uuid (str | None): The UUID of the application, if any.
+        application_name (str | None): The name of the application, if any.
+        domain_url (str | None): The URL of the domain, if any.
+    """
     status: str
     client_id: str
     deployment_id: str
@@ -18,6 +39,16 @@ class DeployResponse(BaseModel):
     domain_url: str | None
 
 class UpdateDeployStatusResponse(BaseModel):
+    """
+    Model representing an update to the deployment status.
+
+    Attributes:
+        status (str): The status of the deployment.
+        deployment_id (str): The unique identifier for the deployment.
+        created_at (float): The timestamp when the deployment was created.
+        last_update_at (float): The timestamp of the last update to the deployment.
+        updated (bool): Indicates whether the deployment status was updated.
+    """
     status: str
     deployment_id: str
     created_at: float
@@ -25,67 +56,192 @@ class UpdateDeployStatusResponse(BaseModel):
     updated: bool
 
 class ListDeployResponse(BaseModel):
+    """
+    Model representing a list of deployment responses.
+
+    Attributes:
+        deployments (list[DeployResponse]): A list of deployment responses.
+    """
     deployments: list[DeployResponse]
 
 class DeployTransactionResponse(ResponseBaseModel):
+    """
+    Model representing a deployment transaction response.
+
+    Attributes:
+        details (DeployResponse | UpdateDeployStatusResponse | ListDeployResponse | None):
+            The details of the deployment transaction response, which can be one of
+            DeployResponse, UpdateDeployStatusResponse, ListDeployResponse, or None.
+    """
     details: DeployResponse | UpdateDeployStatusResponse | ListDeployResponse | None
 
 class ListSecretsDetails(BaseModel):
+    """
+    Model representing the details of listed secrets.
+
+    Attributes:
+        secrets (list[str]): A list of secret strings.
+    """
     secrets: list[str]
 
 class ListSecretsResponse(ResponseBaseModel):
+    """
+    Model representing a response containing the details of listed secrets.
+
+    Attributes:
+        details (ListSecretsDetails | None): The details of the listed secrets, if any.
+    """
     details: ListSecretsDetails | None
 
 class SignupReponseCredentials(BaseModel):
+    """
+    Model representing the credentials for a signup response.
+
+    Attributes:
+        amsdal_access_key_id (str): The access key ID for AMSDAL.
+        amsdal_secret_access_key (str): The secret access key for AMSDAL.
+    """
     amsdal_access_key_id: str
     amsdal_secret_access_key: str
 
 class SignupResponse(ResponseBaseModel):
+    """
+    Model representing a signup response.
+
+    Attributes:
+        details (SignupReponseCredentials | None): The credentials for the signup response, if any.
+    """
     details: SignupReponseCredentials | None
 
 class CreateSessionDetails(BaseModel):
+    """
+    Model representing the details for creating a session.
+
+    Attributes:
+        token (str): The token for the session.
+    """
     token: str
 
 class CreateSessionResponse(ResponseBaseModel):
+    """
+    Model representing a response for creating a session.
+
+    Attributes:
+        details (CreateSessionDetails | None): The details for creating a session, if any.
+    """
     details: CreateSessionDetails | None
 
 class ListDependenciesDetails(BaseModel):
+    """
+    Model representing the details of listed dependencies.
+
+    Attributes:
+        dependencies (list[str]): A list of dependencies.
+        all (list[str]): A list of all dependencies.
+    """
     dependencies: list[str]
     all: list[str]
 
 class ListApplicationDependenciesResponse(ResponseBaseModel):
+    """
+    Model representing a response containing the details of listed application dependencies.
+
+    Attributes:
+        details (ListDependenciesDetails | None): The details of the listed application dependencies, if any.
+    """
     details: ListDependenciesDetails | None
 
 class ExposeApplicationDBResponse(ResponseBaseModel):
+    """
+    Model representing a response for exposing an application database.
+
+    Attributes:
+        details (dict[str, Any] | None): The details of the exposed application database, if any.
+    """
     details: dict[str, Any] | None
 
 class MonitoringInfo(BaseModel):
+    """
+    Model representing monitoring information.
+
+    Attributes:
+        url (str): The URL for monitoring.
+        username (str): The username for monitoring access.
+        password (str): The password for monitoring access.
+    """
     url: str
     username: str
     password: str
 
 class GetMonitoringInfoResponse(ResponseBaseModel):
+    """
+    Model representing a response containing monitoring information.
+
+    Attributes:
+        details (MonitoringInfo | None): The monitoring information details, if any.
+    """
     details: MonitoringInfo | None
 
 class BasicAuthCredentials(BaseModel):
+    """
+    Model representing basic authentication credentials.
+
+    Attributes:
+        username (str): The username for basic authentication.
+        password (str): The password for basic authentication.
+    """
     username: str
     password: str
 
 class AddBasicAuthResponse(ResponseBaseModel):
+    """
+    Model representing a response for adding basic authentication.
+
+    Attributes:
+        details (BasicAuthCredentials | None): The basic authentication credentials, if any.
+    """
     details: BasicAuthCredentials | None
 
 class ListEnvsDetails(BaseModel):
+    """
+    Model representing the details of listed environments.
+
+    Attributes:
+        application_uuid (str): The UUID of the application.
+        application_name (str): The name of the application.
+        environments (list[str]): A list of environment names.
+    """
     application_uuid: str
     application_name: str
     environments: list[str]
 
 class ListEnvsResponse(ResponseBaseModel):
+    """
+    Model representing a response containing the details of listed environments.
+
+    Attributes:
+        details (ListEnvsDetails | None): The details of the listed environments, if any.
+    """
     details: ListEnvsDetails | None
 
 class CreateEnvDetails(BaseModel):
+    """
+    Model representing the details for creating an environment.
+
+    Attributes:
+        environment_name (str): The name of the environment.
+        application_uuid (str): The UUID of the application.
+        application_name (str): The name of the application.
+    """
     environment_name: str
     application_uuid: str
     application_name: str
 
 class CreateEnvResponse(ResponseBaseModel):
+    """
+    Model representing a response for creating an environment.
+
+    Attributes:
+        details (CreateEnvDetails | None): The details for creating an environment, if any.
+    """
     details: CreateEnvDetails | None

amsdal/cloud/services/actions/add_allowlist_ip.pyi

@@ -1,4 +1,19 @@
 from amsdal.cloud.services.actions.base import CloudActionBase as CloudActionBase
 
 class AddAllowlistIPAction(CloudActionBase):
-    def action(self, env_name: str, ip_address: str | None = None, application_name: str | None = None, application_uuid: str | None = None) -> bool: ...
+    """
+    Action class for adding an IP address to the allowlist.
+    """
+    def action(self, env_name: str, ip_address: str | None = None, application_name: str | None = None, application_uuid: str | None = None) -> bool:
+        """
+        Executes the action to add an IP address to the allowlist.
+
+        Args:
+            env_name (str): The name of the environment.
+            ip_address (str, optional): The IP address to add to the allowlist. Defaults to None.
+            application_name (str, optional): The name of the application. Defaults to None.
+            application_uuid (str, optional): The UUID of the application. Defaults to None.
+
+        Returns:
+            bool: True if the action was executed successfully.
+        """

amsdal/cloud/services/actions/add_basic_auth.pyi

@@ -2,4 +2,20 @@ from amsdal.cloud.models.base import AddBasicAuthResponse as AddBasicAuthRespons
 from amsdal.cloud.services.actions.base import CloudActionBase as CloudActionBase
 
 class AddBasicAuthAction(CloudActionBase):
-    def action(self, env_name: str, username: str | None = None, password: str | None = None, application_name: str | None = None, application_uuid: str | None = None) -> AddBasicAuthResponse: ...
+    """
+    Action class for adding basic authentication.
+    """
+    def action(self, env_name: str, username: str | None = None, password: str | None = None, application_name: str | None = None, application_uuid: str | None = None) -> AddBasicAuthResponse:
+        """
+        Executes the action to add basic authentication.
+
+        Args:
+            env_name (str): The name of the environment.
+            username (str, optional): The username for basic authentication. Defaults to None.
+            password (str, optional): The password for basic authentication. Defaults to None.
+            application_name (str, optional): The name of the application. Defaults to None.
+            application_uuid (str, optional): The UUID of the application. Defaults to None.
+
+        Returns:
+            AddBasicAuthResponse: The response containing the basic authentication details.
+        """

amsdal/cloud/services/actions/add_dependency.pyi

@@ -1,4 +1,19 @@
 from amsdal.cloud.services.actions.base import CloudActionBase as CloudActionBase
 
 class AddDepenencyAction(CloudActionBase):
-    def action(self, dependency_name: str, env_name: str, application_name: str | None = None, application_uuid: str | None = None) -> bool: ...
+    """
+    Action class for adding a dependency to an application.
+    """
+    def action(self, dependency_name: str, env_name: str, application_name: str | None = None, application_uuid: str | None = None) -> bool:
+        """
+        Executes the action to add a dependency to an application.
+
+        Args:
+            dependency_name (str): The name of the dependency.
+            env_name (str): The name of the environment.
+            application_name (str, optional): The name of the application. Defaults to None.
+            application_uuid (str, optional): The UUID of the application. Defaults to None.
+
+        Returns:
+            bool: True if the action was executed successfully.
+        """

amsdal/cloud/services/actions/add_secret.pyi

@@ -1,4 +1,20 @@
 from amsdal.cloud.services.actions.base import CloudActionBase as CloudActionBase
 
 class AddSecretAction(CloudActionBase):
-    def action(self, secret_name: str, secret_value: str, env_name: str, application_uuid: str | None = None, application_name: str | None = None) -> bool: ...
+    """
+    Action class for adding a secret to an application.
+    """
+    def action(self, secret_name: str, secret_value: str, env_name: str, application_uuid: str | None = None, application_name: str | None = None) -> bool:
+        """
+        Executes the action to add a secret to an application.
+
+        Args:
+            secret_name (str): The name of the secret.
+            secret_value (str): The value of the secret.
+            env_name (str): The name of the environment.
+            application_uuid (str, optional): The UUID of the application. Defaults to None.
+            application_name (str, optional): The name of the application. Defaults to None.
+
+        Returns:
+            bool: True if the action was executed successfully.
+        """

amsdal/cloud/services/actions/base.pyi

@@ -11,6 +11,37 @@ from enum import Enum
 from typing import Any
 
 class AuthErrorCodes(str, Enum):
+    """
+    Enum for authentication error codes.
+
+    Attributes:
+        INVALID_EMAIL (str): Error code for invalid email.
+        MISSING_CREDENTIALS (str): Error code for missing credentials.
+        INVALID_CREDENTIALS (str): Error code for invalid credentials.
+        INVALID_APPLICATION_UUID (str): Error code for invalid application UUID.
+        CLIENT_IS_INACTIVE (str): Error code for inactive client.
+        CLIENT_ALREADY_EXISTS (str): Error code for client already exists.
+        DEPLOY_FAILED (str): Error code for deploy failed.
+        DEPLOY_ALREADY_EXISTS (str): Error code for deploy already exists.
+        DEPLOY_NOT_IN_DEPLOYED_STATUS (str): Error code for deploy not in deployed status.
+        DESTROY_FAILED (str): Error code for destroy failed.
+        DEPLOY_NOT_FOUND (str): Error code for deploy not found.
+        INVALID_DEPENDENCY (str): Error code for invalid dependency.
+        EXPOSE_DB_ACCESS_FAILED (str): Error code for expose DB access failed.
+        APPLICATION_ALREADY_EXISTS (str): Error code for application already exists.
+        MULTIPLE_APPLICATIONS_FOUND (str): Error code for multiple applications found.
+        MAXIMUM_APPLICATIONS_REACHED (str): Error code for maximum applications reached.
+        INTERNAL_SECRET (str): Error code for internal secret.
+        BA_DOES_NOT_EXIST (str): Error code for basic authentication does not exist.
+        INVALID_IP_ADDRESS (str): Error code for invalid IP address.
+        MONITORING_NOT_FOUND (str): Error code for monitoring not found.
+        INVALID_ENVIRONMENT_NAME (str): Error code for invalid environment name.
+        SAME_ENVIRONMENT_NAME (str): Error code for same environment name.
+        ENVIRONMENT_NOT_FOUND (str): Error code for environment not found.
+        ENVIRONMENT_NOT_DEPLOYED (str): Error code for environment not deployed.
+        MAXIMUM_DEPLOYS_PER_APPLICATION_REACHED (str): Error code for maximum deploys per application reached.
+        CANNOT_DELETE_ENVIRONMENT (str): Error code for cannot delete environment.
+    """
     INVALID_EMAIL = 'invalid_email'
     MISSING_CREDENTIALS = 'missing_credentials'
     INVALID_CREDENTIALS = 'invalid_credentials'
@@ -41,14 +72,51 @@ class AuthErrorCodes(str, Enum):
 FRIENDLY_ERROR_MESSAGES: Incomplete
 
 class CloudActionBase(ABC, metaclass=abc.ABCMeta):
+    """
+    Abstract base class for cloud actions.
+    """
     auth_client: Incomplete
     def __init__(self) -> None: ...
     @abstractmethod
-    def action(self, *args: Any, **kwargs: Any) -> Any: ...
+    def action(self, *args: Any, **kwargs: Any) -> Any:
+        """
+        Abstract method to be implemented by subclasses to execute the action.
+
+        Args:
+            *args (Any): Variable length argument list.
+            **kwargs (Any): Arbitrary keyword arguments.
+
+        Returns:
+            Any: The result of the action.
+        """
     def _credentials_data(self) -> bytes: ...
     @staticmethod
     def _input(msg: str) -> str: ...
     @staticmethod
     def _print(msg: str) -> None: ...
-    def execute_transaction(self, transaction_name: str, data: dict[str, Any]) -> dict[str, Any]: ...
-    def process_errors(self, response: ResponseBaseModel) -> None: ...
+    def execute_transaction(self, transaction_name: str, data: dict[str, Any]) -> dict[str, Any]:
+        """
+        Executes a transaction with the given name and data.
+
+        Args:
+            transaction_name (str): The name of the transaction to execute.
+            data (dict[str, Any]): The data to be sent with the transaction.
+
+        Returns:
+            dict[str, Any]: The response data from the transaction.
+
+        Raises:
+            AmsdalCloudError: If the transaction cannot be executed or if the transaction fails.
+            AmsdalCloudAlreadyDeployedError: If the deploy already exists.
+        """
+    def process_errors(self, response: ResponseBaseModel) -> None:
+        """
+        Processes errors in the response and raises appropriate exceptions.
+
+        Args:
+            response (ResponseBaseModel): The response model containing the status and errors.
+
+        Raises:
+            AmsdalCloudAlreadyDeployedError: If the deploy already exists.
+            AmsdalCloudError: If there are other errors in the response or if the transaction failed.
+        """

amsdal/cloud/services/actions/create_deploy.pyi

@@ -5,7 +5,37 @@ from amsdal.errors import AmsdalCloudAlreadyDeployedError as AmsdalCloudAlreadyD
 from typing import Any
 
 class CreateDeployAction(CloudActionBase):
-    def want_deploy_input(self) -> str: ...
-    def want_redeploy_input(self) -> str: ...
-    def action(self, deploy_type: str, lakehouse_type: str, env_name: str, from_env: str | None = None, application_uuid: str | None = None, application_name: str | None = None, *, no_input: bool = False) -> bool: ...
+    """
+    Class to handle the creation of a deploy action.
+    """
+    def want_deploy_input(self) -> str:
+        """
+        Prompts the user to confirm if they want to deploy the app.
+
+        Returns:
+            str: The user's input, stripped of leading and trailing whitespace.
+        """
+    def want_redeploy_input(self) -> str:
+        """
+        Prompts the user to confirm if they want to redeploy the app.
+
+        Returns:
+            str: The user's input, stripped of leading and trailing whitespace.
+        """
+    def action(self, deploy_type: str, lakehouse_type: str, env_name: str, from_env: str | None = None, application_uuid: str | None = None, application_name: str | None = None, *, no_input: bool = False) -> bool:
+        """
+        Executes the deploy action with the given parameters.
+
+        Args:
+            deploy_type (str): The type of deploy to perform.
+            lakehouse_type (str): The type of lakehouse to deploy.
+            env_name (str): The name of the environment to deploy to.
+            from_env (str | None, optional): The environment to deploy from. Defaults to None.
+            application_uuid (str | None, optional): The UUID of the application. Defaults to None.
+            application_name (str | None, optional): The name of the application. Defaults to None.
+            no_input (bool, optional): If True, skips user input prompts. Defaults to False.
+
+        Returns:
+            bool: True if the deploy action was successful, False otherwise.
+        """
     def _redeploy(self, deploy_data: dict[str, Any]) -> bool: ...

amsdal/cloud/services/actions/create_env.pyi

@@ -2,4 +2,18 @@ from amsdal.cloud.models.base import CreateEnvResponse as CreateEnvResponse
 from amsdal.cloud.services.actions.base import CloudActionBase as CloudActionBase
 
 class CreateEnvAction(CloudActionBase):
-    def action(self, *, env_name: str, application_name: str | None = None, application_uuid: str | None = None) -> CreateEnvResponse: ...
+    """
+    Class to handle the creation of an environment action.
+    """
+    def action(self, *, env_name: str, application_name: str | None = None, application_uuid: str | None = None) -> CreateEnvResponse:
+        """
+        Executes the environment creation action with the given parameters.
+
+        Args:
+            env_name (str): The name of the environment to create.
+            application_name (str | None, optional): The name of the application. Defaults to None.
+            application_uuid (str | None, optional): The UUID of the application. Defaults to None.
+
+        Returns:
+            CreateEnvResponse: The response model containing the details of the created environment.
+        """