fastkit-cli 0.1.6__tar.gz → 0.2.0__tar.gz

{fastkit_cli-0.1.6 → fastkit_cli-0.2.0}/PKG-INFO

@@ -1,11 +1,11 @@
 Metadata-Version: 2.4
 Name: fastkit-cli
-Version: 0.1.6
+Version: 0.2.0
 Summary: FastKit CLI is a code generation tool for the fastkit core package.
-Project-URL: Homepage, https://github.com/codevelo-pub/fastkit-cli
-Project-URL: Documentation, https://github.com/codevelo-pub/fastkit-cli#readme
-Project-URL: Repository, https://github.com/codevelo-pub/fastkit-cli
-Author-email: Codevelo <info@codevelo.io>
+Project-URL: Homepage, https://fastkit.org/docs/fastkit-cli/
+Project-URL: Documentation, https://fastkit.org/docs/fastkit-cli/
+Project-URL: Repository, https://github.com/fastkit-org/fastkit-cli
+Author-email: FastKit Org <hello@fastkit.org>
 License: MIT
 Keywords: api,crud,database,fastapi,framework,laravel,orm,toolkit,web
 Classifier: Development Status :: 4 - Beta

{fastkit_cli-0.1.6 → fastkit_cli-0.2.0}/fastkit_cli/commands/make.py

@@ -121,6 +121,7 @@ def _print_skipped(skipped: list) -> None:
             fg=typer.colors.YELLOW,
         )
 
+
 def _make_init_file(file, force: bool) -> None:
     if not file.exists() or force:
         file.write_text("")
@@ -136,6 +137,7 @@ def module(
     modules_dir: str = typer.Option("modules", "--dir", "-d", help="Modules root directory"),
     force: bool = typer.Option(False, "--force", "-f", help="Overwrite existing files"),
     async_mode: bool = typer.Option(False, "--async", "-a", help="Use async repository and service"),
+    signals: bool = typer.Option(False, "--signals", "-s", help="Also generate signals.py and listeners.py"),
 ):
     """
     Generate a new module with model, schemas, repository, and service.
@@ -154,7 +156,15 @@ def module(
     typer.echo(f"  Location : {module_path}/")
     typer.echo(f"  Model    : {context['model_name']}")
     typer.echo(f"  Table    : {context['table_name']}")
-    typer.echo(f"  Mode     : {'async' if async_mode else 'sync'}")
+    if async_mode and signals:
+        mode = "async + signals"
+    elif async_mode:
+        mode = "async"
+    elif signals:
+        mode = "sync + signals"
+    else:
+        mode = "sync"
+    typer.echo(f"  Mode     : {mode}")
     typer.echo("")
 
     module_path.mkdir(parents=True, exist_ok=True)
@@ -173,6 +183,12 @@ def module(
         ("async_router.py.jinja" if async_mode else "router.py.jinja", "router.py"),
     ]
 
+    if signals:
+        templates += [
+            ("signals.py.jinja", "signals.py"),
+            ("listeners.py.jinja", "listeners.py"),
+        ]
+
     skipped: list = []
     for template_name, output_filename in templates:
         _render_and_write(
@@ -193,6 +209,11 @@ def module(
     typer.echo(f"  1. Define your fields in  {module_path}/models.py")
     typer.echo(f"  2. Add schemas in          {module_path}/schemas.py")
     typer.echo(f"  3. Run: fastkit migrate make -m 'create_{context['table_name']}'")
+
+    if signals:
+        typer.echo(f"  4. Import listeners in main.py:")
+        typer.echo(f"       import modules.{context['table_name']}.listeners")
+
     typer.echo("")
 
 
@@ -372,4 +393,49 @@ def router(
 
     typer.echo("")
     typer.secho("Done!", fg=typer.colors.BRIGHT_WHITE, bold=True)
+    typer.echo("")
+
+@app.command()
+def signals(
+    name: str = typer.Argument(..., help="Module name in PascalCase (e.g. Invoice)"),
+    path: str = typer.Option(".", "--path", "-p", help="Path to target directory"),
+    force: bool = typer.Option(False, "--force", "-f", help="Overwrite existing files"),
+):
+    """
+    Generate signals.py and listeners.py for an existing module.
+
+    \b
+    Example:
+        fastkit make signals Invoice
+        fastkit make signals Invoice --path modules/invoices
+    """
+    context = _build_context(name)
+    module_path = Path(path)
+
+    typer.echo("")
+    typer.secho(f"Generating signals: {context['model_name']}", fg=typer.colors.BRIGHT_CYAN, bold=True)
+    typer.echo(f"  Location : {module_path}/")
+    typer.echo("")
+
+    skipped: list = []
+
+    for template_name, output_filename in [
+        ("signals.py.jinja",   "signals.py"),
+        ("listeners.py.jinja", "listeners.py"),
+    ]:
+        _render_and_write(
+            template_name=template_name,
+            output_path=module_path / output_filename,
+            context=context,
+            force=force,
+            skipped=skipped,
+        )
+
+    _print_skipped(skipped)
+
+    typer.echo("")
+    typer.secho("Done! Next steps:", fg=typer.colors.BRIGHT_WHITE, bold=True)
+    typer.echo(f"  1. Implement receivers in  {module_path}/listeners.py")
+    typer.echo(f"  2. Import listeners in main.py:")
+    typer.echo(f"       import modules.{context['table_name']}.listeners")
     typer.echo("")

fastkit_cli-0.2.0/fastkit_cli/templates/module/listeners.py.jinja

@@ -0,0 +1,56 @@
+# {{ table_name }}/listeners.py
+#
+# Connect receivers to signals using the @signal.connect decorator.
+#
+# IMPORTANT: This file must be imported at application startup for receivers
+# to be registered. Without the import the decorators never run and no
+# receiver will respond to any signal — no error, just silence.
+#
+# Add this to your main.py lifespan or application factory:
+#     import modules.{{ table_name }}.listeners
+#
+from .signals import {{ snake_name }}_created, {{ snake_name }}_updated, {{ snake_name }}_deleted
+
+
+# Uncomment and implement the receivers you need.
+# Each receiver is an async function that accepts the signal payload as a dict.
+# Receiver exceptions are caught and logged — they never propagate to the caller.
+
+
+# @{{ snake_name }}_created.connect
+# async def on_{{ snake_name }}_created(payload: dict) -> None:
+#     """
+#     Called after a {{ model_name }} is successfully created and committed.
+#
+#     Payload keys sent by the service (add your own in after_create):
+#         id: int
+#
+#     Common uses: send notification, invalidate cache, update search index.
+#     """
+#     pass
+
+
+# @{{ snake_name }}_updated.connect
+# async def on_{{ snake_name }}_updated(payload: dict) -> None:
+#     """
+#     Called after a {{ model_name }} is successfully updated and committed.
+#
+#     Payload keys sent by the service (add your own in after_update):
+#         id: int
+#
+#     Common uses: invalidate cache entry, sync external system.
+#     """
+#     pass
+
+
+# @{{ snake_name }}_deleted.connect
+# async def on_{{ snake_name }}_deleted(payload: dict) -> None:
+#     """
+#     Called after a {{ model_name }} is successfully deleted and committed.
+#
+#     Payload keys sent by the service (add your own in after_delete):
+#         id: int
+#
+#     Common uses: delete related files, revoke tokens, release resources.
+#     """
+#     pass

{fastkit_cli-0.1.6 → fastkit_cli-0.2.0}/fastkit_cli/templates/module/schemas.py.jinja

@@ -2,6 +2,8 @@ from typing import Any
 from pydantic import Field
 from fastkit_core.validation import (
     BaseSchema,
+    BaseCreateSchema,
+    BaseUpdateSchema,
     # min_length,       # Uncomment for string min length: name: str = min_length(3)
     # max_length,       # Uncomment for string max length: name: str = max_length(100)
     # length,           # Uncomment for string length range: name: str = length(3, 100)
@@ -16,7 +18,7 @@ from fastkit_core.validation import (
 )
 
 
-class {{ model_name }}Create(BaseSchema):
+class {{ model_name }}Create(BaseCreateSchema):
     """
     Schema for creating a new {{ model_name }}.
 
@@ -31,7 +33,7 @@ class {{ model_name }}Create(BaseSchema):
     pass  # Replace with actual fields
 
 
-class {{ model_name }}Update(BaseSchema):
+class {{ model_name }}Update(BaseUpdateSchema):
     """
     Schema for updating an existing {{ model_name }}.
 
@@ -61,5 +63,3 @@ class {{ model_name }}Response(BaseSchema):
     # description: str | None = None
     created_at: Any = None
     updated_at: Any = None
-
-    model_config = {"from_attributes": True}

fastkit_cli-0.2.0/fastkit_cli/templates/module/signals.py.jinja

@@ -0,0 +1,24 @@
+# {{ table_name }}/signals.py
+#
+# Define module-level Signal instances here.
+# Import these in listeners.py to connect receivers.
+# Import these in service.py to send signals from lifecycle hooks.
+#
+# Signal name convention: 'module_name.event_name'
+# Each Signal instance is independent — receivers connect to the object,
+# not to the name string. Always import from this file, never create new instances.
+#
+# Usage:
+#     from .signals import {{ snake_name }}_created, {{ snake_name }}_updated, {{ snake_name }}_deleted
+
+from fastkit_core.events import Signal
+
+__all__ = [
+    '{{ snake_name }}_created',
+    '{{ snake_name }}_updated',
+    '{{ snake_name }}_deleted',
+]
+
+{{ snake_name }}_created = Signal('{{ snake_name }}.created')
+{{ snake_name }}_updated = Signal('{{ snake_name }}.updated')
+{{ snake_name }}_deleted = Signal('{{ snake_name }}.deleted')

{fastkit_cli-0.1.6 → fastkit_cli-0.2.0}/pyproject.toml

@@ -4,13 +4,13 @@ build-backend = "hatchling.build"
 
 [project]
 name = "fastkit-cli"
-version = "0.1.6"
+version = "0.2.0"
 description = "FastKit CLI is a code generation tool for the fastkit core package."
 readme = "README.md"
 requires-python = ">=3.12"
 license = {text = "MIT"}
 authors = [
-    {name = "Codevelo", email = "info@codevelo.io"}
+    {name = "FastKit Org", email = "hello@fastkit.org"}
 ]
 keywords = [
     "fastapi",
@@ -46,9 +46,9 @@ dependencies = [
 fastkit = "fastkit_cli.main:app"
 
 [project.urls]
-Homepage = "https://github.com/codevelo-pub/fastkit-cli"
-Documentation = "https://github.com/codevelo-pub/fastkit-cli#readme"
-Repository = "https://github.com/codevelo-pub/fastkit-cli"
+Homepage = "https://fastkit.org/docs/fastkit-cli/"
+Documentation = "https://fastkit.org/docs/fastkit-cli/"
+Repository = "https://github.com/fastkit-org/fastkit-cli"
 
 [tool.hatch.build.targets.wheel]
 include = [