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

amsdal/cloud/services/actions/signup_action.pyi

@@ -2,4 +2,19 @@ from amsdal.cloud.models.base import SignupReponseCredentials as SignupReponseCr
 from amsdal.cloud.services.actions.base import CloudActionBase as CloudActionBase
 
 class FreeSignupAction(CloudActionBase):
-    def action(self, organization_name: str, email: str) -> SignupReponseCredentials: ...
+    """
+    Class to handle the free signup action.
+
+    This class provides functionality to sign up a client for free using the provided organization name and email.
+    """
+    def action(self, organization_name: str, email: str) -> SignupReponseCredentials:
+        """
+        Executes the free signup action with the given parameters.
+
+        Args:
+            organization_name (str): The name of the organization.
+            email (str): The email address for signup.
+
+        Returns:
+            SignupReponseCredentials: The response containing the signup credentials.
+        """

amsdal/cloud/services/actions/update_deploy.pyi

@@ -2,4 +2,18 @@ from amsdal.cloud.models.base import UpdateDeployStatusResponse as UpdateDeployS
 from amsdal.cloud.services.actions.base import CloudActionBase as CloudActionBase
 
 class UpdateDeployAction(CloudActionBase):
-    def action(self, deployment_id: str) -> UpdateDeployStatusResponse: ...
+    """
+    Class to handle the update of deployment status.
+
+    This class provides functionality to update the status of a deployment using the given deployment ID.
+    """
+    def action(self, deployment_id: str) -> UpdateDeployStatusResponse:
+        """
+        Updates the status of a deployment with the given deployment ID.
+
+        Args:
+            deployment_id (str): The ID of the deployment to be updated.
+
+        Returns:
+            UpdateDeployStatusResponse: The response containing the updated deployment status.
+        """

amsdal/cloud/services/auth/credentials.pyi

@@ -9,6 +9,11 @@ from amsdal.errors import AmsdalAuthenticationError as AmsdalAuthenticationError
 from amsdal.schemas.manager import SchemaManager as SchemaManager
 
 class CredentialsAuthHandler(AuthHandlerBase):
+    """
+    Handles authentication using credentials.
+
+    This class provides functionality to authenticate using an access key ID and a secret access key.
+    """
     __access_key_id: Incomplete
     __secret_access_key: Incomplete
     __fernet: Incomplete
@@ -17,4 +22,10 @@ class CredentialsAuthHandler(AuthHandlerBase):
     def _create_session(self) -> str: ...
     def _get_public_key(self) -> str: ...
     def _decode_public_key(self, key: str) -> str: ...
-    def validate_credentials(self) -> None: ...
+    def validate_credentials(self) -> None:
+        """
+        Validates the provided credentials by creating a session and decoding the public key.
+
+        Raises:
+            AmsdalAuthenticationError: If the credentials are invalid.
+        """

amsdal/cloud/services/auth/manager.pyi

@@ -7,6 +7,20 @@ from amsdal.errors import AmsdalAuthenticationError as AmsdalAuthenticationError
 from amsdal_utils.utils.singleton import Singleton
 
 class AuthManager(metaclass=Singleton):
+    """
+    Manages authentication for the application.
+
+    This class handles the initialization and validation of authentication credentials based on
+        the provided authentication type.
+    """
     _auth_handler: AuthHandlerBase
     def __init__(self, auth_type: AuthType | None = None) -> None: ...
-    def authenticate(self) -> None: ...
+    def authenticate(self) -> None:
+        """
+        Authenticates the user by validating the provided credentials.
+
+        This method uses the authentication handler to validate the credentials based on the authentication type.
+
+        Raises:
+            AmsdalAuthenticationError: If the authentication fails.
+        """

amsdal/cloud/services/auth/signup_service.pyi

@@ -13,5 +13,20 @@ def organization_name_input() -> str: ...
 def email_input() -> str: ...
 
 class SignupService:
+    """
+    Service to handle the signup process for the Amsdal Framework.
+
+    This class provides functionality to prompt the user for signup details, validate the license agreement,
+    and create credentials for the user.
+    """
     @classmethod
-    def signup_prompt(cls) -> bool: ...
+    def signup_prompt(cls) -> bool:
+        """
+        Prompts the user to sign up for the Amsdal Framework.
+
+        This method guides the user through the signup process, including accepting the license agreement and
+        entering organization and email details. It then creates credentials for the user.
+
+        Returns:
+            bool: True if the signup process is completed successfully, False otherwise.
+        """

amsdal/cloud/services/auth/token.pyi

@@ -7,8 +7,22 @@ from amsdal.schemas.manager import SchemaManager as SchemaManager
 HMAC_KEY: bytes
 
 class TokenAuthHandler(AuthHandlerBase):
+    """
+    Handles authentication using a token.
+
+    This class provides functionality to authenticate using a JWT token and validate its checksum.
+    """
     __token: Incomplete
     public_key: Incomplete
     def __init__(self, token: str | None, public_key: str = ...) -> None: ...
     def _validate_checksum(self, expected_checksum: str) -> None: ...
-    def validate_credentials(self) -> None: ...
+    def validate_credentials(self) -> None:
+        """
+        Validates the provided JWT token.
+
+        This method decodes the token and validates its checksum or expiration date.
+
+        Raises:
+            AmsdalAuthenticationError: If the token is expired, has an invalid signature, is invalid, or is missing
+                an expiration date.
+        """

amsdal/configs/constants.py

@@ -15,6 +15,16 @@ PRODUCTION_ENVIRONMENT = 'production'
 
 
 def get_default_environment() -> str:
+    """
+    Determines the default environment based on the command used to run the script.
+
+    This function checks the command used to run the script and returns the appropriate
+    environment string. If the script is run using `pytest`, it returns 'testing'. Otherwise,
+    it returns 'development'.
+
+    Returns:
+        str: The default environment string, either 'testing' or 'development'.
+    """
     cmd = sys.argv[0] if sys.argv else ''
 
     if 'pytest' in cmd:

amsdal/configs/constants.pyi

@@ -9,4 +9,14 @@ TESTING_ENVIRONMENT: str
 DEVELOPMENT_ENVIRONMENT: str
 PRODUCTION_ENVIRONMENT: str
 
-def get_default_environment() -> str: ...
+def get_default_environment() -> str:
+    """
+    Determines the default environment based on the command used to run the script.
+
+    This function checks the command used to run the script and returns the appropriate
+    environment string. If the script is run using `pytest`, it returns 'testing'. Otherwise,
+    it returns 'development'.
+
+    Returns:
+        str: The default environment string, either 'testing' or 'development'.
+    """

amsdal/configs/main.py

@@ -11,6 +11,33 @@ from pydantic_settings import SettingsConfigDict
 
 
 class Settings(BaseSettings):
+    """
+    Configuration settings for the application.
+
+    This class defines the configuration settings for the application, including paths,
+    environment variables, and other settings.
+
+    Attributes:
+        model_config (SettingsConfigDict): Configuration for the settings model.
+        APP_PATH (Path): Path to the app directory where the generated models and other files will be placed.
+        CONFIG_PATH (Path | None): Path to the config.yml file. If not specified, the default APP_PATH/config.yml
+            file will be used.
+        MODELS_MODULE_NAME (str): The models module name. The generated models will be placed in this module.
+        SCHEMAS_MODULE_NAME (str): The schemas module name. The schemas will be placed in this module.
+        FIXTURES_MODULE_NAME (str): The fixtures module name. The fixtures will be placed in this module.
+        STATIC_MODULE_NAME (str): The static module name. The static files will be placed in this module.
+        TRANSACTIONS_MODULE_NAME (str): The transactions module name. The transactions will be placed in this module.
+        MIGRATIONS_DIRECTORY_NAME (str): The migrations directory name. The migration files will be placed in this
+            folder.
+        ACCESS_KEY_ID (str | None): The access key that you will get during registering process.
+        SECRET_ACCESS_KEY (str | None): The secret access key that you will get during registering process.
+        ACCESS_TOKEN (str | None): The access token that you will get during sign in process.
+        SANDBOX_ENVIRONMENT (bool | None): If True, the sandbox environment will be used. If False,
+            the cloud environment will be used.
+        CONTRIBS (list[str]): List of contrib modules that will be loaded and used.
+            Can be specified via environment variable AMSDAL_CONTRIBS as comma separated string.
+    """
+
     model_config = SettingsConfigDict(
         case_sensitive=True,
         env_prefix='AMSDAL_',
@@ -20,43 +47,36 @@ class Settings(BaseSettings):
     )
 
     APP_PATH: Path = Path('.')
-    """Path to the app directory where the generated models and other files will be placed."""
-
     CONFIG_PATH: Path | None = None
-    """Path to the config.yml file. If not specified, the default APP_PATH/config.yml file will be used."""
-
     MODELS_MODULE_NAME: str = 'models'
-    """The models module name. The generated models will be placed in this module."""
     SCHEMAS_MODULE_NAME: str = 'schemas'
-    """The schemas module name. The schemas will be placed in this module."""
     FIXTURES_MODULE_NAME: str = 'fixtures'
-    """The fixtures module name. The fixtures will be placed in this module."""
     STATIC_MODULE_NAME: str = 'static'
-    """The static module name. The static files will be placed in this module."""
     TRANSACTIONS_MODULE_NAME: str = 'transactions'
-    """The transactions module name. The transactions will be placed in this module."""
     MIGRATIONS_DIRECTORY_NAME: str = 'migrations'
-    """The migrations directory name. The migration files will be placed in this folder."""
-
     ACCESS_KEY_ID: str | None = None
-    """The access key that you will get during registering process."""
     SECRET_ACCESS_KEY: str | None = None
-    """The secret access key that you will get during registering process."""
     ACCESS_TOKEN: str | None = None
-    """The access token that you will get during sign in process."""
-
     SANDBOX_ENVIRONMENT: bool | None = None
-    """If True, the sandbox environment will be used. If False, the cloud environment will be used."""
-
     CONTRIBS: list[str] = [
         'amsdal.contrib.auth.app.AuthAppConfig',
         'amsdal.contrib.frontend_configs.app.FrontendConfigAppConfig',
     ]
-    """List of contrib modules that will be loaded and used. Can be specified via environment variable AMSDAL_CONTRIBS
-    as comma separated string."""
 
     @field_validator('CONTRIBS', mode='after')
     def load_contrib_modules(cls, value: list[str]) -> list[str]:  # noqa: N805
+        """
+        Loads and initializes contrib modules.
+
+        This method takes a list of contrib module paths, imports each module, and calls the `on_ready` method
+        of the `AppConfig` class within each module.
+
+        Args:
+            value (list[str]): A list of contrib module paths in the format 'package.module.ClassName'.
+
+        Returns:
+            list[str]: The same list of contrib module paths after loading and initializing the modules.
+        """
         from amsdal.contrib.app_config import AppConfig
 
         for contrib_module in value:
@@ -69,30 +89,93 @@ class Settings(BaseSettings):
 
     @property
     def models_root_path(self) -> Path:
+        """
+        Returns the root path for models.
+
+        This property constructs and returns the path to the models directory
+        based on the `APP_PATH` and `MODELS_MODULE_NAME` attributes.
+
+        Returns:
+            Path: The root path for the models directory.
+        """
         return self.APP_PATH / self.MODELS_MODULE_NAME
 
     @property
     def schemas_root_path(self) -> Path:
+        """
+        Returns the root path for schemas.
+
+        This property constructs and returns the path to the schemas directory
+        based on the `APP_PATH` and `SCHEMAS_MODULE_NAME` attributes.
+
+        Returns:
+            Path: The root path for the schemas directory.
+        """
         return self.APP_PATH / self.SCHEMAS_MODULE_NAME
 
     @property
     def fixtures_root_path(self) -> Path:
+        """
+        Returns the root path for fixtures.
+
+        This property constructs and returns the path to the fixtures directory
+        based on the `APP_PATH` and `FIXTURES_MODULE_NAME` attributes.
+
+        Returns:
+            Path: The root path for the fixtures directory.
+        """
         return self.APP_PATH / self.FIXTURES_MODULE_NAME
 
     @property
     def static_root_path(self) -> Path:
+        """
+        Returns the root path for static files.
+
+        This property constructs and returns the path to the static files directory
+        based on the `APP_PATH` and `STATIC_MODULE_NAME` attributes.
+
+        Returns:
+            Path: The root path for the static files directory.
+        """
         return self.APP_PATH / self.STATIC_MODULE_NAME
 
     @property
     def transactions_root_path(self) -> Path:
+        """
+        Returns the root path for transactions.
+
+        This property constructs and returns the path to the transactions directory
+        based on the `models_root_path` and `TRANSACTIONS_MODULE_NAME` attributes.
+
+        Returns:
+            Path: The root path for the transactions directory.
+        """
         return self.models_root_path / self.TRANSACTIONS_MODULE_NAME
 
     @property
     def migrations_root_path(self) -> Path:
+        """
+        Returns the root path for migrations.
+
+        This property constructs and returns the path to the migrations directory
+        based on the `models_root_path` and `MIGRATIONS_DIRECTORY_NAME` attributes.
+
+        Returns:
+            Path: The root path for the migrations directory.
+        """
         return self.models_root_path / self.MIGRATIONS_DIRECTORY_NAME
 
     @model_validator(mode='after')
     def check_passwords_match(self) -> 'Settings':
+        """
+        Ensures the configuration path is set.
+
+        This method checks if the `CONFIG_PATH` attribute is set. If it is not set,
+        it assigns a default path based on the `APP_PATH` attribute.
+
+        Returns:
+            Settings: The updated settings instance with the `CONFIG_PATH` attribute set.
+        """
         config_path = self.CONFIG_PATH
 
         if not config_path:
@@ -108,15 +191,45 @@ else:
 
 
 class SettingsProxy(base):
+    """
+    Proxy class for accessing and modifying settings.
+
+    This class acts as a proxy for the `Settings` class, allowing for dynamic
+    overriding and accessing of settings attributes.
+    """
+
     def __init__(self) -> None:
         self._settings = Settings()
 
     def override(self, **kwargs: Any) -> None:
+        """
+        Overrides settings with provided keyword arguments.
+
+        This method updates the current settings with the provided keyword arguments.
+
+        Args:
+            **kwargs: Keyword arguments representing settings to override.
+
+        Returns:
+            None
+        """
         new_settings = self._settings.model_dump()
         new_settings.update(kwargs)
         self._settings = Settings(**new_settings)
 
     def model_dump(self, *args: Any, **kwargs: Any) -> dict[str, Any]:
+        """
+        Dumps the current settings model to a dictionary.
+
+        This method returns the current settings as a dictionary.
+
+        Args:
+            *args: Additional positional arguments to pass to the underlying model dump method.
+            **kwargs: Additional keyword arguments to pass to the underlying model dump method.
+
+        Returns:
+            dict[str, Any]: The current settings as a dictionary.
+        """
         return self._settings.model_dump(*args, **kwargs)
 
     def __getattr__(self, name: str) -> Any:

amsdal/configs/main.pyi

@@ -4,6 +4,32 @@ from pydantic_settings import BaseSettings
 from typing import Any, TypeAlias
 
 class Settings(BaseSettings):
+    """
+    Configuration settings for the application.
+
+    This class defines the configuration settings for the application, including paths,
+    environment variables, and other settings.
+
+    Attributes:
+        model_config (SettingsConfigDict): Configuration for the settings model.
+        APP_PATH (Path): Path to the app directory where the generated models and other files will be placed.
+        CONFIG_PATH (Path | None): Path to the config.yml file. If not specified, the default APP_PATH/config.yml
+            file will be used.
+        MODELS_MODULE_NAME (str): The models module name. The generated models will be placed in this module.
+        SCHEMAS_MODULE_NAME (str): The schemas module name. The schemas will be placed in this module.
+        FIXTURES_MODULE_NAME (str): The fixtures module name. The fixtures will be placed in this module.
+        STATIC_MODULE_NAME (str): The static module name. The static files will be placed in this module.
+        TRANSACTIONS_MODULE_NAME (str): The transactions module name. The transactions will be placed in this module.
+        MIGRATIONS_DIRECTORY_NAME (str): The migrations directory name. The migration files will be placed in this
+            folder.
+        ACCESS_KEY_ID (str | None): The access key that you will get during registering process.
+        SECRET_ACCESS_KEY (str | None): The secret access key that you will get during registering process.
+        ACCESS_TOKEN (str | None): The access token that you will get during sign in process.
+        SANDBOX_ENVIRONMENT (bool | None): If True, the sandbox environment will be used. If False,
+            the cloud environment will be used.
+        CONTRIBS (list[str]): List of contrib modules that will be loaded and used.
+            Can be specified via environment variable AMSDAL_CONTRIBS as comma separated string.
+    """
     model_config: Incomplete
     APP_PATH: Path
     CONFIG_PATH: Path | None
@@ -18,28 +44,132 @@ class Settings(BaseSettings):
     ACCESS_TOKEN: str | None
     SANDBOX_ENVIRONMENT: bool | None
     CONTRIBS: list[str]
-    def load_contrib_modules(cls, value: list[str]) -> list[str]: ...
+    def load_contrib_modules(cls, value: list[str]) -> list[str]:
+        """
+        Loads and initializes contrib modules.
+
+        This method takes a list of contrib module paths, imports each module, and calls the `on_ready` method
+        of the `AppConfig` class within each module.
+
+        Args:
+            value (list[str]): A list of contrib module paths in the format 'package.module.ClassName'.
+
+        Returns:
+            list[str]: The same list of contrib module paths after loading and initializing the modules.
+        """
     @property
-    def models_root_path(self) -> Path: ...
+    def models_root_path(self) -> Path:
+        """
+        Returns the root path for models.
+
+        This property constructs and returns the path to the models directory
+        based on the `APP_PATH` and `MODELS_MODULE_NAME` attributes.
+
+        Returns:
+            Path: The root path for the models directory.
+        """
     @property
-    def schemas_root_path(self) -> Path: ...
+    def schemas_root_path(self) -> Path:
+        """
+        Returns the root path for schemas.
+
+        This property constructs and returns the path to the schemas directory
+        based on the `APP_PATH` and `SCHEMAS_MODULE_NAME` attributes.
+
+        Returns:
+            Path: The root path for the schemas directory.
+        """
     @property
-    def fixtures_root_path(self) -> Path: ...
+    def fixtures_root_path(self) -> Path:
+        """
+        Returns the root path for fixtures.
+
+        This property constructs and returns the path to the fixtures directory
+        based on the `APP_PATH` and `FIXTURES_MODULE_NAME` attributes.
+
+        Returns:
+            Path: The root path for the fixtures directory.
+        """
     @property
-    def static_root_path(self) -> Path: ...
+    def static_root_path(self) -> Path:
+        """
+        Returns the root path for static files.
+
+        This property constructs and returns the path to the static files directory
+        based on the `APP_PATH` and `STATIC_MODULE_NAME` attributes.
+
+        Returns:
+            Path: The root path for the static files directory.
+        """
     @property
-    def transactions_root_path(self) -> Path: ...
+    def transactions_root_path(self) -> Path:
+        """
+        Returns the root path for transactions.
+
+        This property constructs and returns the path to the transactions directory
+        based on the `models_root_path` and `TRANSACTIONS_MODULE_NAME` attributes.
+
+        Returns:
+            Path: The root path for the transactions directory.
+        """
     @property
-    def migrations_root_path(self) -> Path: ...
-    def check_passwords_match(self) -> Settings: ...
+    def migrations_root_path(self) -> Path:
+        """
+        Returns the root path for migrations.
+
+        This property constructs and returns the path to the migrations directory
+        based on the `models_root_path` and `MIGRATIONS_DIRECTORY_NAME` attributes.
+
+        Returns:
+            Path: The root path for the migrations directory.
+        """
+    def check_passwords_match(self) -> Settings:
+        """
+        Ensures the configuration path is set.
+
+        This method checks if the `CONFIG_PATH` attribute is set. If it is not set,
+        it assigns a default path based on the `APP_PATH` attribute.
+
+        Returns:
+            Settings: The updated settings instance with the `CONFIG_PATH` attribute set.
+        """
 
 base: TypeAlias
 
 class SettingsProxy(base):
+    """
+    Proxy class for accessing and modifying settings.
+
+    This class acts as a proxy for the `Settings` class, allowing for dynamic
+    overriding and accessing of settings attributes.
+    """
     _settings: Incomplete
     def __init__(self) -> None: ...
-    def override(self, **kwargs: Any) -> None: ...
-    def model_dump(self, *args: Any, **kwargs: Any) -> dict[str, Any]: ...
+    def override(self, **kwargs: Any) -> None:
+        """
+        Overrides settings with provided keyword arguments.
+
+        This method updates the current settings with the provided keyword arguments.
+
+        Args:
+            **kwargs: Keyword arguments representing settings to override.
+
+        Returns:
+            None
+        """
+    def model_dump(self, *args: Any, **kwargs: Any) -> dict[str, Any]:
+        """
+        Dumps the current settings model to a dictionary.
+
+        This method returns the current settings as a dictionary.
+
+        Args:
+            *args: Additional positional arguments to pass to the underlying model dump method.
+            **kwargs: Additional keyword arguments to pass to the underlying model dump method.
+
+        Returns:
+            dict[str, Any]: The current settings as a dictionary.
+        """
     def __getattr__(self, name: str) -> Any: ...
     def __delattr__(self, name: str) -> None: ...
     def __setattr__(self, name: str, value: Any) -> None: ...

amsdal/context/manager.py

@@ -5,8 +5,24 @@ _CONTEXT: ContextVar[dict[str, Any] | None] = ContextVar('_context', default=Non
 
 
 class AmsdalContextManager:
+    """
+    Manages a context for storing and retrieving data.
+
+    This class provides methods to get, set, and add to a context stored in a
+    `ContextVar`. The context is a dictionary that can hold any key-value pairs.
+    """
+
     @classmethod
     def get_context(cls) -> dict[str, Any]:
+        """
+        Retrieves the current context or creates a new one if none exists.
+
+        This method gets the current context from the `_CONTEXT` variable. If no
+        context exists, it creates a new empty context and sets it.
+
+        Returns:
+            dict[str, Any]: The current context.
+        """
         _context = _CONTEXT.get()
 
         if _context is not None:
@@ -19,10 +35,33 @@ class AmsdalContextManager:
 
     @classmethod
     def set_context(cls, context: dict[str, Any]) -> None:
+        """
+        Sets the context to the provided dictionary.
+
+        This method sets the `_CONTEXT` variable to the provided context.
+
+        Args:
+            context (dict[str, Any]): The context to set.
+
+        Returns:
+            None
+        """
         _CONTEXT.set(context)
 
     @classmethod
     def add_to_context(cls, key: str, value: Any) -> None:
+        """
+        Adds a key-value pair to the current context.
+
+        This method adds the provided key-value pair to the current context.
+
+        Args:
+            key (str): The key to add to the context.
+            value (Any): The value to associate with the key.
+
+        Returns:
+            None
+        """
         context = cls.get_context()
 
         context[key] = value