amsdal_cli 0.0.1__py3-none-any.whl

amsdal_cli/__about__.py

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

amsdal_cli/app.py

@@ -0,0 +1,8 @@
+import typer
+
+from amsdal_cli.commands.callbacks import init_app_context
+
+app = typer.Typer(
+    callback=init_app_context,
+    invoke_without_command=True,
+)

amsdal_cli/commands/build/command.py

@@ -0,0 +1,27 @@
+from pathlib import Path
+
+import typer
+
+from amsdal_cli.app import app
+from amsdal_cli.commands.build.utils.build_app import build_app
+from amsdal_cli.commands.generate.enums import SOURCES_DIR
+from amsdal_cli.utils.cli_config import CliConfig
+
+
+@app.command(name='build')
+def build_command(
+    ctx: typer.Context,
+    output: Path = typer.Argument('.', help='Path to output directory'),  # noqa: B008
+    config: Path = typer.Option(None, help='Path to custom config.yml file'),  # noqa: B008
+) -> None:
+    """
+    Build the app and generate the models and other files.
+    """
+    cli_config: CliConfig = ctx.meta['config']
+    app_source_path = cli_config.app_directory / SOURCES_DIR
+
+    build_app(
+        app_source_path=app_source_path,
+        config_path=config or cli_config.config_path,
+        output=output,
+    )

amsdal_cli/commands/build/constants.py

@@ -0,0 +1 @@
+TRANSACTION_FILE_NAME = 'transactions.py'

amsdal_cli/commands/build/utils/build_app.py

@@ -0,0 +1,46 @@
+from pathlib import Path
+
+from amsdal_framework.configs.main import settings
+from amsdal_framework.manager import AmsdalManager
+from amsdal_utils.config.manager import AmsdalConfigManager
+from rich import print
+
+from amsdal_cli.commands.build.utils.build_config_file import build_config_file
+
+
+def build_app(
+    app_source_path: Path,
+    config_path: Path,
+    output: Path = Path('.'),
+) -> None:
+    settings.override(APP_PATH=output)
+    config_manager = AmsdalConfigManager()
+    config_manager.load_config(config_path)
+    amsdal_manager = AmsdalManager()
+    amsdal_manager.pre_setup()
+
+    print('[blue]Building models...[/blue]', end=' ')
+    amsdal_manager.build_models(app_source_path / 'models')
+    print('[green]OK![/green]')
+
+    if output == Path('.'):
+        print('[yellow]No output directory specified, skipping config.yml generation[/yellow]')
+    else:
+        # build config file
+        build_config_file(
+            output_path=output,
+            config_path=config_path,
+            no_input=True,
+        )
+
+    print('[blue]Building transactions...[/blue]', end=' ')
+    amsdal_manager.build_transactions(app_source_path)
+    print('[green]OK![/green]')
+
+    print('[blue]Building static files...[/blue]', end=' ')
+    amsdal_manager.build_static_files(app_source_path)
+    print('[green]OK![/green]')
+
+    print('[blue]Building fixtures...[/blue]', end=' ')
+    amsdal_manager.build_fixtures(app_source_path / 'models')
+    print('[green]OK![/green]')

amsdal_cli/commands/build/utils/build_config_file.py

@@ -0,0 +1,36 @@
+from pathlib import Path
+
+import typer
+from rich import print
+
+
+def build_config_file(
+    output_path: Path,
+    config_path: Path,
+    *,
+    no_input: bool,
+) -> None:
+    print('[blue]Building config.yml file...[/blue]', end=' ')
+
+    if not config_path.exists() or not config_path.name.endswith('.yml'):
+        print(f'\n[red]Config file "{config_path.resolve()}" does not exist or has wrong extension.[/red]')
+        raise typer.Exit(1)
+
+    config_destination = output_path / 'config.yml'
+
+    if (
+        no_input
+        or not config_destination.exists()
+        or (
+            typer.confirm(
+                f'\nThe config file "{config_destination.resolve()}" already exists. Would you like to overwrite it?',
+            )
+        )
+    ):
+        config_destination.parent.mkdir(parents=True, exist_ok=True)
+        config_destination.touch(exist_ok=True)
+
+        with config_path.open('rt') as _file:
+            config_destination.write_text(_file.read())
+
+    print('[green]OK![/green]')

amsdal_cli/commands/callbacks.py

@@ -0,0 +1,47 @@
+import json
+import os
+from json import JSONDecodeError
+from pathlib import Path
+
+import typer
+from rich import print
+
+from amsdal_cli.utils.cli_config import CliConfig
+
+COMMANDS_DO_NOT_REQUIRE_APP_PATH = ('new', 'migrate', 'write_logs')
+
+
+def init_app_context(ctx: typer.Context) -> None:
+    """
+    AMSDAL CLI - a tool that provides the ability to create a new app,
+    generate models, transactions, build, serve, and other useful features
+    for the efficient building of new apps using AMSDAL Framework.
+    """
+    if not ctx.invoked_subcommand:
+        return
+
+    templates_path = Path(__file__).parent / ctx.invoked_subcommand / 'templates'
+
+    if ctx.invoked_subcommand in COMMANDS_DO_NOT_REQUIRE_APP_PATH:
+        ctx.meta['config'] = CliConfig(templates_path=templates_path)
+
+        return
+
+    app_path = Path(os.getcwd())
+    cli_config = app_path / '.amsdal-cli'
+
+    if not cli_config.exists():
+        print(f'[red]The directory "{app_path.resolve()}" does not contain AMSDAL application.[/red]')
+        print('Use the "amsdal new --help" command to see details about how to create an application.')
+        raise typer.Exit(1)
+
+    with cli_config.open('rt') as config_file:
+        try:
+            ctx.meta['config'] = CliConfig(
+                app_directory=app_path,
+                templates_path=templates_path,
+                **json.loads(config_file.read()),
+            )
+        except JSONDecodeError as err:
+            print(f'[red]The config file "{cli_config.resolve()}" is corrupted.[/red]')
+            raise typer.Exit(1) from err

amsdal_cli/commands/generate/app.py

@@ -0,0 +1,5 @@
+import typer
+
+sub_app = typer.Typer(
+    help="Generates application's files such as models, properties, transactions, etc.",
+)

amsdal_cli/commands/generate/command.py

@@ -0,0 +1,5 @@
+from amsdal_cli.app import app
+from amsdal_cli.commands.generate.app import sub_app
+from amsdal_cli.commands.generate.sub_commands import *  # noqa
+
+app.add_typer(sub_app, name='generate')

amsdal_cli/commands/generate/enums.py

@@ -0,0 +1,52 @@
+from enum import Enum
+
+SOURCES_DIR = 'src'
+MODEL_JSON_FILE = 'model.json'
+MODEL_PY_FILE = 'model.py'
+FIXTURES_JSON_FILE = 'fixtures.json'
+
+
+class HookName(str, Enum):
+    PRE_INIT = 'pre_init'
+    POST_INIT = 'post_init'
+    PRE_CREATE = 'pre_create'
+    POST_CREATE = 'post_create'
+    PRE_UPDATE = 'pre_update'
+    POST_UPDATE = 'post_update'
+    PRE_DELETE = 'pre_delete'
+    POST_DELETE = 'post_delete'
+
+
+class ModifierName(str, Enum):
+    CONSTRUCTOR = 'constructor'
+    DISPLAY_NAME = 'display_name'
+    VERSION_NAME = 'version_name'
+
+
+class ModelFormat(str, Enum):
+    JSON = 'json'
+    PY = 'py'
+
+
+class AttributeType(str, Enum):
+    STRING = 'string'
+    NUMBER = 'number'
+    BOOLEAN = 'boolean'
+    BELONGS_TO = 'belongs-to'
+    HAS_MANY = 'has-many'
+    DICT = 'dict'
+
+
+class JsonType(str, Enum):
+    STRING = 'string'
+    NUMBER = 'number'
+    BOOLEAN = 'boolean'
+    ARRAY = 'array'
+    DICT = 'dictionary'
+
+
+class OptionName(str, Enum):
+    INDEX = 'index'
+    DEFAULT = 'default'
+    REQUIRED = 'required'
+    UNIQUE = 'unique'

amsdal_cli/commands/generate/sub_commands/__init__.py

@@ -0,0 +1,13 @@
+from amsdal_cli.commands.generate.sub_commands.generate_hook import generate_hook
+from amsdal_cli.commands.generate.sub_commands.generate_model import generate_model
+from amsdal_cli.commands.generate.sub_commands.generate_modifier import generate_modifier
+from amsdal_cli.commands.generate.sub_commands.generate_property import generate_property
+from amsdal_cli.commands.generate.sub_commands.generate_transaction import generate_transaction
+
+__all__ = [
+    'generate_model',
+    'generate_property',
+    'generate_hook',
+    'generate_modifier',
+    'generate_transaction',
+]

amsdal_cli/commands/generate/sub_commands/generate_hook.py

@@ -0,0 +1,35 @@
+import typer
+
+from amsdal_cli.commands.generate.app import sub_app
+from amsdal_cli.commands.generate.enums import HookName
+from amsdal_cli.commands.generate.utils.build_base_path import build_model_base_path
+from amsdal_cli.utils.cli_config import CliConfig
+from amsdal_cli.utils.copier import copy_blueprint
+
+
+@sub_app.command(name='hook')
+def generate_hook(
+    ctx: typer.Context,
+    hook_name: HookName = typer.Argument(  # noqa: B008
+        ...,
+        help='The hook name.',
+    ),
+    model: str = typer.Option(..., help='The model name. It should be provided in PascalCase.'),
+) -> None:
+    """
+    Generates hook file for specified model.
+    """
+    cli_config: CliConfig = ctx.meta['config']
+    base_path = build_model_base_path(ctx, model)
+    output_path = base_path / 'hooks'
+
+    copy_blueprint(
+        source_file_path=cli_config.templates_path / 'hook.pyt',
+        destination_path=output_path,
+        destination_name=f'{hook_name.value}.py',
+        context={
+            'hook_name': hook_name.value,
+            'is_init': hook_name in (HookName.PRE_INIT, HookName.POST_INIT),
+        },
+        confirm_overwriting=True,
+    )

amsdal_cli/commands/generate/sub_commands/generate_model.py

@@ -0,0 +1,94 @@
+import json
+from typing import Any
+
+import typer
+from amsdal_utils.utils.text import classify
+from amsdal_utils.utils.text import to_snake_case
+from rich import print
+
+from amsdal_cli.commands.generate.app import sub_app
+from amsdal_cli.commands.generate.enums import MODEL_JSON_FILE
+from amsdal_cli.commands.generate.enums import SOURCES_DIR
+from amsdal_cli.commands.generate.enums import ModelFormat
+from amsdal_cli.commands.generate.utils.model_attributes import parse_attributes
+from amsdal_cli.utils.cli_config import CliConfig
+from amsdal_cli.utils.copier import write_file
+
+
+@sub_app.command(name='model')
+def generate_model(
+    ctx: typer.Context,
+    model_name: str = typer.Argument(
+        ...,
+        help='The model name. It should be provided in PascalCase.',
+    ),
+    model_format: ModelFormat = typer.Option(ModelFormat.JSON.value, '--format'),  # noqa: B008
+    attrs: list[str] = typer.Option(  # noqa: B008
+        (None,),
+        '--attributes',
+        '-attrs',
+    ),
+    unique: list[str] = typer.Option(  # noqa: B008
+        (None,),
+        '--unique',
+        '-u',
+    ),
+) -> None:
+    """
+    Generates model file.
+
+    Example of usage:
+
+    >>> bin/cli --app-path ./apps/my_app/ generate model UserProfile --format json -attrs "name:string \
+        email:string:index age:number:default=18"
+    """
+
+    if model_format == ModelFormat.PY:
+        print('[red]The PY format is not supported for now.[/red]')
+        raise typer.Exit
+
+    cli_config: CliConfig = ctx.meta['config']
+    model_name = classify(model_name)
+    name = to_snake_case(model_name)
+
+    output_path = cli_config.app_directory / SOURCES_DIR / 'models' / name
+    parsed_attrs = parse_attributes(attrs)
+
+    schema: dict[str, Any] = {
+        'title': model_name,
+        'type': 'object',
+        'properties': {},
+        'required': [attr.name for attr in parsed_attrs if attr.required],
+        'indexed': [attr.name for attr in parsed_attrs if attr.index],
+    }
+
+    unique_attrs: list[str | tuple[str, ...]] = [attr.name for attr in parsed_attrs if attr.unique]
+
+    for _unique in filter(None, unique):
+        _unique_attrs = tuple(map(str.strip, _unique.split(',')))
+
+        if _unique_attrs not in unique_attrs:
+            unique_attrs.append(_unique_attrs)
+
+    if unique_attrs:
+        schema['unique_properties'] = unique_attrs
+
+    for attr in parsed_attrs:
+        property_info: dict[str, Any] = {
+            'title': attr.name,
+            'type': attr.json_type,
+        }
+
+        if attr.has_items:
+            property_info['items'] = attr.json_items
+
+        if attr.default != attr.NotSet:
+            property_info['default'] = attr.default
+
+        schema['properties'][attr.name] = property_info
+
+    write_file(
+        json.dumps(schema, indent=cli_config.json_indent),
+        destination_file_path=output_path / MODEL_JSON_FILE,
+        confirm_overwriting=True,
+    )

amsdal_cli/commands/generate/sub_commands/generate_modifier.py

@@ -0,0 +1,32 @@
+import typer
+
+from amsdal_cli.commands.generate.app import sub_app
+from amsdal_cli.commands.generate.enums import ModifierName
+from amsdal_cli.commands.generate.utils.build_base_path import build_model_base_path
+from amsdal_cli.utils.cli_config import CliConfig
+from amsdal_cli.utils.copier import copy_blueprint
+
+
+@sub_app.command(name='modifier')
+def generate_modifier(
+    ctx: typer.Context,
+    modifier_name: ModifierName = typer.Argument(  # noqa: B008
+        ...,
+        help='The modifier name.',
+    ),
+    model: str = typer.Option(..., help='The model name. It should be provided in PascalCase.'),
+) -> None:
+    """
+    Generates modifier file for specified model.
+    """
+    cli_config: CliConfig = ctx.meta['config']
+    base_path = build_model_base_path(ctx, model)
+    modifier_path = base_path / 'modifiers'
+
+    copy_blueprint(
+        source_file_path=cli_config.templates_path / 'modifier' / f'{modifier_name.value}.pyt',
+        destination_path=modifier_path,
+        destination_name=f'{modifier_name.value}.py',
+        context={},
+        confirm_overwriting=True,
+    )

amsdal_cli/commands/generate/sub_commands/generate_property.py

@@ -0,0 +1,38 @@
+import typer
+from amsdal_utils.utils.text import to_snake_case
+
+from amsdal_cli.commands.generate.app import sub_app
+from amsdal_cli.commands.generate.utils.build_base_path import build_model_base_path
+from amsdal_cli.utils.cli_config import CliConfig
+from amsdal_cli.utils.copier import copy_blueprint
+
+
+@sub_app.command(name='property')
+def generate_property(
+    ctx: typer.Context,
+    property_name: str = typer.Argument(
+        ...,
+        help=(
+            'The property name. Note, it will always transform the provided name to camel_case. Enter the name in '
+            'camel_case in order to avoid any issues.'
+        ),
+    ),
+    model: str = typer.Option(..., help='The model name. It should be provided in PascalCase.'),
+) -> None:
+    """
+    Generates property file for specified model.
+    """
+    cli_config: CliConfig = ctx.meta['config']
+    base_path = build_model_base_path(ctx, model)
+    name = to_snake_case(property_name)
+    output_path = base_path / 'properties'
+
+    copy_blueprint(
+        source_file_path=cli_config.templates_path / 'property.pyt',
+        destination_path=output_path,
+        destination_name=f'{name}.py',
+        context={
+            'property_name': name,
+        },
+        confirm_overwriting=True,
+    )

amsdal_cli/commands/generate/sub_commands/generate_transaction.py

@@ -0,0 +1,38 @@
+import typer
+from amsdal_utils.utils.text import classify
+from amsdal_utils.utils.text import to_snake_case
+
+from amsdal_cli.commands.generate.app import sub_app
+from amsdal_cli.commands.generate.enums import SOURCES_DIR
+from amsdal_cli.utils.cli_config import CliConfig
+from amsdal_cli.utils.copier import copy_blueprint
+
+
+@sub_app.command(name='transaction')
+def generate_transaction(
+    ctx: typer.Context,
+    transaction_name: str = typer.Argument(
+        ...,
+        help=(
+            'The transaction name. Note, it will always transform the provided name to camel_case. Enter the name in '
+            'camel_case in order to avoid any issues.'
+        ),
+    ),
+) -> None:
+    """
+    Generates transaction file for specified model.
+    """
+    cli_config: CliConfig = ctx.meta['config']
+    name = to_snake_case(transaction_name)
+    output_path = cli_config.app_directory / SOURCES_DIR / 'transactions'
+
+    copy_blueprint(
+        source_file_path=cli_config.templates_path / 'transaction.pyt',
+        destination_path=output_path,
+        destination_name=f'{name}.py',
+        context={
+            'transaction_method_name': name,
+            'transaction_class_name': classify(transaction_name),
+        },
+        confirm_overwriting=True,
+    )

amsdal_cli/commands/generate/templates/hook.pyt

@@ -0,0 +1,3 @@
+def {{ ctx.hook_name }}(self{% if ctx.is_init %}, is_new_object, **kwargs{% endif %}):
+    # TODO: implementation here
+    ...

amsdal_cli/commands/generate/templates/modifier/constructor.pyt

@@ -0,0 +1,10 @@
+def __init__(self, **kwargs):
+    # Add implementation here
+    # Note, **kwargs contain raw data, which is not validated yet.
+
+    super().__init__(**kwargs)
+
+    # Or add implementation here
+    # Note, **kwargs were validated, converted to the correct types and
+    # assigned to the corresponding fields.
+    # So you safely can use them here via self.

amsdal_cli/commands/generate/templates/modifier/display_name.pyt

@@ -0,0 +1,4 @@
+@property
+def display_name(self) -> str:
+    # TODO: implementation here
+    ...

amsdal_cli/commands/generate/templates/modifier/version_name.pyt

@@ -0,0 +1,4 @@
+@property
+def version_name(self) -> str:
+    # TODO: implementation here
+    ...

amsdal_cli/commands/generate/templates/property.pyt

@@ -0,0 +1,4 @@
+@property
+def {{ ctx.property_name }}(self):
+    # TODO: implementation here
+    ...

amsdal_cli/commands/generate/templates/transaction.pyt

@@ -0,0 +1,7 @@
+from amsdal_data.transactions import transaction
+
+
+@transaction(name="{{ ctx.transaction_class_name }}")
+def {{ ctx.transaction_method_name }}():
+    # TODO: implementation here
+    ...

amsdal_cli/commands/generate/utils/build_base_path.py

@@ -0,0 +1,22 @@
+from pathlib import Path
+
+import typer
+from amsdal_utils.utils.text import to_snake_case
+from rich import print
+
+from amsdal_cli.commands.generate.enums import SOURCES_DIR
+from amsdal_cli.utils.cli_config import CliConfig
+
+
+def build_model_base_path(ctx: typer.Context, model_name: str) -> Path:
+    cli_config: CliConfig = ctx.meta['config']
+    model = to_snake_case(model_name)
+    model_path = cli_config.app_directory / SOURCES_DIR / 'models' / model
+
+    if cli_config.check_model_exists and not (
+        (model_path / 'model.json').exists() or (model_path / 'model.py').exists()
+    ):
+        print(f'[red]The model "{model_name}" does not exist.[/red]')
+        raise typer.Exit
+
+    return model_path

amsdal_cli/commands/generate/utils/cast_to_attribute_type.py

@@ -0,0 +1,19 @@
+from typing import Any
+
+from amsdal_cli.commands.generate.enums import AttributeType
+
+
+def cast_to_attribute_type(
+    attr_type: AttributeType,
+    value: str,
+) -> Any:
+    if value.lower() == 'null':
+        return None
+
+    match attr_type:
+        case AttributeType.NUMBER:
+            return float(value)
+        case AttributeType.BOOLEAN:
+            return value.lower() == 'true'
+        case _:
+            return value