amsdal_cli 0.5.3__tar.gz → 0.5.4__tar.gz

{amsdal_cli-0.5.3 → amsdal_cli-0.5.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: amsdal_cli
-Version: 0.5.3
+Version: 0.5.4
 Summary: CLI for AMSDAL framework
 Project-URL: Documentation, https://pypi.org/project/amsdal_cli/#readme
 Project-URL: Issues, https://pypi.org/project/amsdal_cli/

{amsdal_cli-0.5.3 → amsdal_cli-0.5.4}/change-logs.md

@@ -1,3 +1,9 @@
+## [v0.5.4](https://pypi.org/project/amsdal_cli/0.5.4/) - 2025-08-14
+
+### Added
+
+- Plugin commands
+
 ## [v0.5.3](https://pypi.org/project/amsdal_cli/0.5.3/) - 2025-08-01
 
 ### Changed

amsdal_cli-0.5.4/latest-changelogs.md

@@ -0,0 +1,5 @@
+## [v0.5.4](https://pypi.org/project/amsdal_cli/0.5.4/) - 2025-08-14
+
+### Added
+
+- Plugin commands

{amsdal_cli-0.5.3 → amsdal_cli-0.5.4}/pyproject.toml

@@ -167,7 +167,7 @@ all = [
 target-version = ["py311"]
 line-length = 120
 skip-string-normalization = true
-exclude = "tests/fixtures/*|.venv"
+exclude = "tests/fixtures/*|.venv|src/amsdal_cli/commands/plugin/templates/*"
 
 [tool.mypy]
 plugins = ["pydantic.mypy"]
@@ -177,7 +177,7 @@ warn_unused_ignores = true
 disallow_any_generics = true
 check_untyped_defs = true
 no_implicit_reexport = true
-exclude = "tests/fixtures/*"
+exclude = "tests/fixtures/*|src/amsdal_cli/commands/plugin/templates/*"
 
 # for strict mypy: (this is the tricky one :-))
 disallow_untyped_defs = true
@@ -199,7 +199,7 @@ warn_required_dynamic_aliases = true
 [tool.ruff]
 target-version = "py310"
 line-length = 120
-exclude = ["tests/fixtures/"]
+exclude = ["tests/fixtures/", "src/amsdal_cli/commands/plugin/templates/"]
 
 [tool.ruff.lint]
 select = [

{amsdal_cli-0.5.3 → amsdal_cli-0.5.4}/src/amsdal_cli/__about__.py

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

{amsdal_cli-0.5.3 → amsdal_cli-0.5.4}/src/amsdal_cli/commands/callbacks.py

@@ -8,7 +8,7 @@ from amsdal_utils.config.manager import AmsdalConfigManager
 from rich import print as rprint
 from typer import Option
 
-COMMANDS_DO_NOT_REQUIRE_APP_PATH = ('new', 'n', 'api-check')
+COMMANDS_DO_NOT_REQUIRE_APP_PATH = ('new', 'n', 'plugin', 'api-check')
 
 
 def init_app_context(

{amsdal_cli-0.5.3 → amsdal_cli-0.5.4}/src/amsdal_cli/commands/migrations/sub_commands/__init__.py

@@ -7,10 +7,12 @@ from amsdal_cli.commands.migrations.app import sub_app
 from amsdal_cli.commands.migrations.sub_commands.apply import apply_migrations
 from amsdal_cli.commands.migrations.sub_commands.list import list_migrations
 from amsdal_cli.commands.migrations.sub_commands.make import make_migrations
+from amsdal_cli.commands.migrations.sub_commands.make_contrib import make_contrib_migrations
 
 __all__ = [
     'apply_migrations',
     'list_migrations',
+    'make_contrib_migrations',
     'make_migrations',
 ]
 

amsdal_cli-0.5.4/src/amsdal_cli/commands/migrations/sub_commands/make_contrib.py

@@ -0,0 +1,179 @@
+import asyncio
+from pathlib import Path
+from typing import TYPE_CHECKING
+from typing import Annotated
+
+import typer
+from rich import print as rprint
+
+from amsdal_cli.commands.migrations.app import sub_app
+from amsdal_cli.utils.cli_config import ModelsFormat
+
+if TYPE_CHECKING:
+    from amsdal_cli.utils.cli_config import CliConfig
+
+
+def _sync_make_contrib_migrations(
+    name: str | None,
+    *,
+    is_data: bool,
+    cli_config: 'CliConfig',
+) -> None:
+    from amsdal.configs.constants import CORE_MIGRATIONS_PATH
+    from amsdal.configs.main import settings
+    from amsdal.manager import AmsdalManager
+    from amsdal_models.migration.data_classes import MigrationFile
+    from amsdal_models.migration.file_migration_generator import FileMigrationGenerator
+    from amsdal_utils.utils.text import to_snake_case
+
+    from amsdal_cli.commands.generate.enums import SOURCES_DIR
+    from amsdal_cli.commands.migrations.constants import MIGRATIONS_DIR_NAME
+    from amsdal_cli.utils.schema_repository import build_schema_repository
+    from amsdal_cli.utils.text import rich_info
+    from amsdal_cli.utils.text import rich_success
+
+    amsdal_manager = AmsdalManager()
+    if not amsdal_manager._is_setup:
+        amsdal_manager.setup()
+    amsdal_manager.authenticate()
+    amsdal_manager.post_setup()  # type: ignore[call-arg]
+
+    schema_repository = build_schema_repository(cli_config=cli_config)
+    migrations_dir: Path = cli_config.app_directory / SOURCES_DIR / MIGRATIONS_DIR_NAME
+
+    generator = FileMigrationGenerator(
+        core_migrations_path=CORE_MIGRATIONS_PATH,
+        app_migrations_path=migrations_dir,
+        contrib_migrations_directory_name=settings.CONTRIB_MIGRATIONS_DIRECTORY_NAME,
+    )
+
+    try:
+        name = to_snake_case(name) if name else None
+        migration: MigrationFile = generator.make_migrations(
+            schemas=schema_repository.contrib_schemas,
+            name=name,
+            is_data=is_data,
+        )
+    except UserWarning as warn:
+        rprint(rich_info(str(warn)))
+    else:
+        rprint(rich_success(f'Contrib migration created: {migration.path.name}'))
+
+    try:
+        amsdal_manager.teardown()
+        AmsdalManager.invalidate()
+    except Exception:  # noqa: S110
+        pass
+
+
+async def _async_make_contrib_migrations(
+    name: str | None,
+    *,
+    is_data: bool,
+    cli_config: 'CliConfig',
+) -> None:
+    from amsdal.configs.constants import CORE_MIGRATIONS_PATH
+    from amsdal.configs.main import settings
+    from amsdal.manager import AsyncAmsdalManager
+    from amsdal_models.migration.data_classes import MigrationFile
+    from amsdal_models.migration.file_migration_generator import AsyncFileMigrationGenerator
+    from amsdal_utils.utils.text import to_snake_case
+
+    from amsdal_cli.commands.generate.enums import SOURCES_DIR
+    from amsdal_cli.commands.migrations.constants import MIGRATIONS_DIR_NAME
+    from amsdal_cli.utils.schema_repository import build_schema_repository
+    from amsdal_cli.utils.text import rich_info
+    from amsdal_cli.utils.text import rich_success
+
+    amsdal_manager = AsyncAmsdalManager()
+    if not amsdal_manager.is_setup:
+        await amsdal_manager.setup()
+    amsdal_manager.authenticate()
+    await amsdal_manager.post_setup()  # type: ignore[call-arg, misc]
+
+    schema_repository = build_schema_repository(cli_config=cli_config)
+    migrations_dir: Path = cli_config.app_directory / SOURCES_DIR / MIGRATIONS_DIR_NAME
+
+    generator = AsyncFileMigrationGenerator(
+        core_migrations_path=CORE_MIGRATIONS_PATH,
+        app_migrations_path=migrations_dir,
+        contrib_migrations_directory_name=settings.CONTRIB_MODELS_PACKAGE_NAME,
+    )
+
+    try:
+        name = to_snake_case(name) if name else None
+        migration: MigrationFile = await generator.make_migrations(
+            schemas=schema_repository.contrib_schemas,
+            name=name,
+            is_data=is_data,
+        )
+    except UserWarning as warn:
+        rprint(rich_info(str(warn)))
+    else:
+        rprint(rich_success(f'Contrib migration created: {migration.path.name}'))
+
+    await amsdal_manager.teardown()
+    AsyncAmsdalManager.invalidate()
+
+
+@sub_app.command(name='new-contrib, nc')
+def make_contrib_migrations(
+    ctx: typer.Context,
+    build_dir: Annotated[Path, typer.Option('--build-dir', '-b')] = Path('.'),
+    *,
+    name: Annotated[str, typer.Option('--name', '-n', help='Migration name')] = None,  # type: ignore # noqa: RUF013
+    is_data: Annotated[bool, typer.Option('--data', '-d', help='Create data migration')] = False,
+    config: Annotated[Path, typer.Option('--config', '-c')] = None,  # type: ignore # noqa: RUF013
+) -> None:
+    """
+    Creates schema migration based on the changes in the contrib models' schemas or
+    creates an empty data migration using --data flag.
+
+    Example usage:
+
+    1. Automatically creates a schema migrations based on the changes in the contrib models' schemas:
+    ```bash
+    amsdal migrations new-contrib
+    ```
+
+    2. Creates a schema migration with a custom name:
+    ```bash
+    amsdal migrations new-contrib --name my_custom_contrib_migration
+    ```
+
+    3. Creates a data migration:
+    ```bash
+    amsdal migrations new-contrib --data --name my_contrib_data_migration
+    ```
+    The data migrations allow you to write a python script to migrate your data. Useful for example when you have added
+    a new column to the table and you want to populate it with some data. So you first generate a schema migration that
+    adds the column and then you create a data migration that populates the column with the data.
+    """
+    from amsdal_utils.config.manager import AmsdalConfigManager
+
+    from amsdal_cli.commands.build.services.builder import AppBuilder
+    from amsdal_cli.utils.cli_config import CliConfig
+
+    cli_config: CliConfig = ctx.meta['config']
+
+    app_builder = AppBuilder(
+        cli_config=cli_config,
+        config_path=config or cli_config.config_path,
+    )
+    app_builder.build(build_dir, is_silent=True)
+    cli_config.models_format = ModelsFormat.PY
+
+    if AmsdalConfigManager().get_config().async_mode:
+        asyncio.run(
+            _async_make_contrib_migrations(
+                name=name,
+                is_data=is_data,
+                cli_config=cli_config,
+            )
+        )
+    else:
+        _sync_make_contrib_migrations(
+            name=name,
+            is_data=is_data,
+            cli_config=cli_config,
+        )

amsdal_cli-0.5.4/src/amsdal_cli/commands/plugin/command.py

@@ -0,0 +1,149 @@
+import random
+import string
+import uuid
+from pathlib import Path
+from typing import Annotated
+from typing import Any
+
+import typer
+from rich import print as rprint
+
+from amsdal_cli.app import app
+from amsdal_cli.utils.cli_config import ModelsFormat
+
+
+@app.command(name='plugin')
+def plugin_command(
+    plugin_name: str = typer.Argument(
+        ...,
+        help='The Plugin name. For example: MyPlugin',
+    ),
+    output_path: Path = typer.Argument(  # noqa: B008
+        ...,
+        help='Output path, where the plugin will be created.',
+    ),
+    *,
+    models_format: Annotated[
+        ModelsFormat,
+        typer.Option(help='The format of models used in this plugin.'),
+    ] = ModelsFormat.PY,
+    is_async_mode: Annotated[
+        bool,
+        typer.Option('--async', help='Whether to run the plugin in async mode.'),
+    ] = False,
+) -> None:
+    """
+    Generates a new AMSDAL plugin.
+
+    Example:
+
+    ```bash
+    amsdal plugin MyPlugin .
+    ```
+
+    It will create `my_plugin` directory in the current directory with AMSDAL plugin structure.
+    """
+    from amsdal.__about__ import __version__ as amsdal_version
+    from amsdal_utils.utils.text import slugify
+    from amsdal_utils.utils.text import to_snake_case
+
+    from amsdal_cli.commands.generate.enums import SOURCES_DIR
+    from amsdal_cli.utils.copier import copy_blueprints_from_directory
+    from amsdal_cli.utils.text import rich_error
+    from amsdal_cli.utils.text import rich_success
+
+    if not output_path.exists():
+        rprint(rich_error(f'The output path "{output_path.resolve()}" does not exist.'))
+        raise typer.Exit
+
+    if output_path.is_file():
+        rprint(rich_error(f'The output path "{output_path.resolve()}" is not a directory.'))
+        raise typer.Exit
+
+    output_path /= to_snake_case(plugin_name)
+
+    if output_path.exists():
+        if output_path.is_file():
+            rprint(rich_error(f'The path "{output_path.resolve()}" is not a directory.'))
+            raise typer.Exit
+
+        if any(output_path.iterdir()):
+            rprint(rich_error(f'The directory "{output_path.resolve()}" is not empty.'))
+            raise typer.Exit
+
+    application_uuid = (random.choice(string.ascii_lowercase) + uuid.uuid4().hex[:31]).lower()  # noqa: S311
+
+    context = {
+        'application_uuid': application_uuid,
+        'plugin_name': plugin_name,
+        'plugin_name_slugify': slugify(plugin_name),
+        'plugin_name_snake': to_snake_case(plugin_name),
+        'amsdal_version': amsdal_version,
+        'models_format': models_format.value,
+        'is_async_mode': is_async_mode,
+    }
+
+    copy_blueprints_from_directory(
+        source_path=Path(__file__).parent / 'templates',
+        destination_path=output_path,
+        context=context,
+    )
+    (output_path / SOURCES_DIR).mkdir(exist_ok=True)
+
+    # Create example model based on format
+    _create_example_model(output_path, models_format, context)
+
+    rprint(rich_success(f'The plugin is successfully created in {output_path.resolve()}'))
+
+
+def _create_example_model(output_path: Path, models_format: ModelsFormat, context: dict[str, Any]) -> None:
+    """Create an example model based on the specified format."""
+    from amsdal_cli.utils.copier import write_file
+
+    models_dir = output_path / 'src' / 'models'
+
+    if models_format == ModelsFormat.JSON:
+        # Create JSON model
+        model_dir = models_dir / 'example_model'
+        model_dir.mkdir(exist_ok=True)
+
+        json_content = """{
+    "title": "ExampleModel",
+    "type": "object",
+    "properties": {
+        "name": {
+            "title": "name",
+            "type": "string"
+        },
+        "description": {
+            "title": "description",
+            "type": "string"
+        },
+        "is_active": {
+            "title": "is_active",
+            "type": "boolean",
+            "default": true
+        }
+    },
+    "required": [
+        "name"
+    ],
+    "indexed": [
+        "name"
+    ]
+}"""
+        write_file(json_content, model_dir / 'model.json', confirm_overwriting=False)
+    else:
+        # Create Python model
+        py_content = f"""from amsdal.types import BaseModel
+from amsdal.types import Field
+
+
+class ExampleModel(BaseModel):
+    \"\"\"Example model for {context['plugin_name']} plugin.\"\"\"
+
+    name: str = Field(..., index=True)
+    description: str = Field(default="")
+    is_active: bool = Field(default=True)
+"""
+        write_file(py_content, models_dir / 'example_model.py', confirm_overwriting=False)

amsdal_cli-0.5.4/src/amsdal_cli/commands/plugin/templates/.amsdal-cli

@@ -0,0 +1,10 @@
+{
+    "config_path": "./plugin.yml",
+    "http_port": 8080,
+    "check_model_exists": true,
+    "json_indent": 4,
+    "application_uuid": "{{ ctx.application_uuid }}",
+    "application_name": "{{ ctx.plugin_name }}",
+    "models_format": "{{ ctx.models_format }}",
+    "is_plugin": true
+}

amsdal_cli-0.5.4/src/amsdal_cli/commands/plugin/templates/README.md

@@ -0,0 +1,49 @@
+# {{ ctx.plugin_name }}
+
+This plugin provides custom models, properties, transactions, and hooks for the AMSDAL Framework.
+
+## Plugin Structure
+
+- `src/models/` - Contains model definitions{% if ctx.models_format == 'json' %} in JSON format{% else %} in Python format{% endif %}
+- `src/transactions/` - Contains transaction definitions
+- `plugin.yml` - Plugin configuration file
+
+## Installing this Plugin
+
+To use this plugin in an AMSDAL application:
+
+1. Copy the plugin directory to your AMSDAL application
+2. Import the models and transactions as needed
+3. Register the plugin in your application configuration
+
+## Development
+
+This plugin uses {% if ctx.is_async_mode %}async{% else %}sync{% endif %} mode.
+
+### Adding Models
+
+```bash
+amsdal generate model ModelName --format {{ ctx.models_format }}
+```
+
+### Adding Properties
+
+```bash
+amsdal generate property --model ModelName property_name
+```
+
+### Adding Transactions
+
+```bash
+amsdal generate transaction TransactionName
+```
+
+### Adding Hooks
+
+```bash
+amsdal generate hook --model ModelName on_create
+```
+
+## Testing
+
+Test your plugin by integrating it with an AMSDAL application and running the application's test suite.

amsdal_cli-0.5.4/src/amsdal_cli/commands/plugin/templates/plugin.yml

@@ -0,0 +1,20 @@
+plugin_name: {{ ctx.plugin_name_slugify }}
+plugin_type: amsdal_plugin
+version: "1.0.0"
+async_mode: {{ 'true' if ctx.is_async_mode else 'false' }}
+models_format: {{ ctx.models_format }}
+
+description: "{{ ctx.plugin_name }} plugin for AMSDAL Framework"
+
+# Plugin metadata
+author: ""
+license: ""
+homepage: ""
+
+# Dependencies (if any)
+dependencies: []
+
+# Plugin configuration
+config:
+  models_directory: "src/models"
+  transactions_directory: "src/transactions"

amsdal_cli-0.5.4/src/amsdal_cli/commands/plugin/templates/requirements.txt

@@ -0,0 +1 @@
+amsdal[cli]=={{ ctx.amsdal_version }}

amsdal_cli-0.5.4/src/amsdal_cli/commands/plugin/templates/src/models/__init__.py

@@ -0,0 +1 @@
+# Models module for {{ ctx.plugin_name }} plugin

amsdal_cli-0.5.4/src/amsdal_cli/commands/plugin/templates/src/transactions/__init__.py

@@ -0,0 +1 @@
+# Transactions module for {{ ctx.plugin_name }} plugin

amsdal_cli-0.5.4/src/amsdal_cli/commands/plugin/templates/src/transactions/example_transaction.py

@@ -0,0 +1,47 @@
+{% if ctx.is_async_mode %}from amsdal.core.classes.base import transaction
+
+
+@transaction(name='ExampleTransaction')
+async def example_transaction(name: str, description: str = "") -> None:
+    """
+    Example transaction for {{ ctx.plugin_name }} plugin.
+    
+    Args:
+        name: Name for the example model
+        description: Description for the example model
+    """
+    # TODO: Add your transaction logic here
+    # Example:
+    # from models.example_model import ExampleModel
+    # 
+    # new_model = ExampleModel(
+    #     name=name,
+    #     description=description,
+    #     is_active=True
+    # )
+    # await new_model.async_save()
+    pass
+{% else %}from amsdal.core.classes.base import transaction
+
+
+@transaction(name='ExampleTransaction')
+def example_transaction(name: str, description: str = "") -> None:
+    """
+    Example transaction for {{ ctx.plugin_name }} plugin.
+    
+    Args:
+        name: Name for the example model
+        description: Description for the example model
+    """
+    # TODO: Add your transaction logic here
+    # Example:
+    # from models.example_model import ExampleModel
+    # 
+    # new_model = ExampleModel(
+    #     name=name,
+    #     description=description,
+    #     is_active=True
+    # )
+    # new_model.save()
+    pass
+{% endif %}

{amsdal_cli-0.5.3 → amsdal_cli-0.5.4}/src/amsdal_cli/config/main.py

@@ -22,6 +22,7 @@ class Settings(BaseSettings):
         default=[
             'amsdal_cli.commands.api_check',
             'amsdal_cli.commands.new',
+            'amsdal_cli.commands.plugin',
             'amsdal_cli.commands.generate',
             'amsdal_cli.commands.verify',
             'amsdal_cli.commands.build',