instant-python 0.1.1__tar.gz → 0.2.0__tar.gz

instant_python-0.2.0/.github/workflows/pages.yml

@@ -0,0 +1,34 @@
+name: Publish to GitHub pages
+
+on:
+  push:
+    branches:
+      - main
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: write
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: "pages"
+  cancel-in-progress: true
+
+jobs:
+  pages:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ./.github/actions/python_setup
+      - name: Build documentation
+        run: uv run mkdocs build
+      - name: Deploy to GitHub Pages
+        run: uv run mkdocs gh-deploy --force
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

{instant_python-0.1.1 → instant_python-0.2.0}/.github/workflows/release.yml

@@ -1,9 +1,7 @@
 name: Generate Release
 
 on:
-  push:
-    branches:
-      - main
+  workflow_dispatch:
 
 jobs:
   bump-version:

{instant_python-0.1.1 → instant_python-0.2.0}/CHANGELOG.md

@@ -1,3 +1,28 @@
+## 0.2.0 (2025-04-08)
+
+### ✨ Features
+
+- **template**: add new rabbit mq error when user selects event bus built in feature
+- **template**: create rabbit_mq_connection_not_established_error.py boilerplate
+
+### 🐛 Bug Fixes
+
+- **template**: correct domain event type not found error import and class name
+- **template**: set event bus publish method async
+- **template**: correct imports in value objects boilerplate
+
+### ♻️ Code Refactoring
+
+- **installer**: add virtual environment creation before installing dependencies
+- **template**: conditionally include bounded context based on specify_bounded_context field
+- **template**: add specify_bounded_context field to user requirements
+- **prompter**: be able to execute nested conditional questions
+- **template**: update subquestions structure to use ConditionalQuestion for bounded context specification
+- **prompter**: extend ConditionalQuestion subquestions type hint
+- **prompter**: remove note when prompting built in features for the user to select and remove temporarily synch sql alchemy option
+- **template**: modify project structure templates to include logger and alembic migrator automatically if fastapi application is selected
+- **template**: modify DomainEventSubscriber boilerplate to follow generic type syntax depending on python version
+
 ## 0.1.1 (2025-04-08)
 
 ### 🐛 Bug Fixes

{instant_python-0.1.1 → instant_python-0.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: instant-python
-Version: 0.1.1
+Version: 0.2.0
 Summary: Python automatic project generator
 Author-email: dimanu-py <diegomtz126@gmail.com>
 License:                                  Apache License

{instant_python-0.1.1 → instant_python-0.2.0}/instant_python/installer/pdm_manager.py

@@ -31,6 +31,7 @@ class PdmManager(DependencyManager):
         print(f">>> Python {version} installed successfully")
 
     def install_dependencies(self, dependencies: list[str]) -> None:
+        self._create_virtual_environment()
         for dependency_name in dependencies:
             self._install_dependency(dependency_name)
 
@@ -67,6 +68,12 @@ class PdmManager(DependencyManager):
             group_flag += f"--group {group_name}"
         return f"{dev_flag} {group_flag}"
 
-
-
-
+    def _create_virtual_environment(self) -> None:
+        command = f"{self._pdm} install"
+        subprocess.run(
+            command,
+            shell=True,
+            check=True,
+            cwd=self._project_directory,
+            stdout=subprocess.DEVNULL,
+        )

{instant_python-0.1.1 → instant_python-0.2.0}/instant_python/installer/uv_manager.py

@@ -33,6 +33,7 @@ class UvManager(DependencyManager):
         print(f">>> Python {version} installed successfully")
 
     def install_dependencies(self, dependencies: list[str]) -> None:
+        self._create_virtual_environment()
         for dependency_name in dependencies:
             self._install_dependency(dependency_name)
 
@@ -71,3 +72,13 @@ class UvManager(DependencyManager):
             ).ask()["group_name"]
             flag = f"--group {group_name}"
         return flag
+
+    def _create_virtual_environment(self) -> None:
+        command = f"{self._uv} sync"
+        subprocess.run(
+            command,
+            shell=True,
+            check=True,
+            cwd=self._project_directory,
+            stdout=subprocess.DEVNULL,
+        )

{instant_python-0.1.1 → instant_python-0.2.0}/instant_python/question_prompter/question/conditional_question.py

@@ -1,9 +1,11 @@
+from typing import Union
+
 from instant_python.question_prompter.question.question import Question
 
 
 class ConditionalQuestion:
     def __init__(
-        self, base_question: Question, subquestions: list[Question], condition: str | bool
+        self, base_question: Question, subquestions: Union[list[Question], "ConditionalQuestion"], condition: str | bool
     ) -> None:
         self._base_question = base_question
         self._subquestions = subquestions
@@ -16,8 +18,12 @@ class ConditionalQuestion:
             return base_answer
 
         answers = base_answer
-        for question in self._subquestions:
-            answers.update(question.ask())
+        
+        if isinstance(self._subquestions, ConditionalQuestion):
+            answers.update(self._subquestions.ask())
+        else:
+            for question in self._subquestions:
+                answers.update(question.ask())
         return answers
 
     def _base_answer_does_not_satisfies_condition(self, base_answer: dict[str, str]) -> bool:

{instant_python-0.1.1 → instant_python-0.2.0}/instant_python/question_prompter/step/template_step.py

@@ -1,3 +1,4 @@
+from instant_python.question_prompter.question.boolean_question import BooleanQuestion
 from instant_python.question_prompter.question.choice_question import ChoiceQuestion
 from instant_python.question_prompter.question.conditional_question import (
     ConditionalQuestion,
@@ -17,12 +18,11 @@ class TemplateStep(Step):
         self._questions = [
             MultipleChoiceQuestion(
                 key="built_in_features",
-                message="Select the built-in features you want to include (fastapi_application option requires logger)",
+                message="Select the built-in features you want to include",
                 options=[
                     "value_objects",
                     "github_actions",
                     "makefile",
-                    "synchronous_sqlalchemy",
                     "logger",
                     "event_bus",
                     "async_sqlalchemy",
@@ -40,18 +40,26 @@ class TemplateStep(Step):
                         "standard_project",
                     ],
                 ),
-                subquestions=[
-                    FreeTextQuestion(
-                        key="bounded_context",
-                        message="Enter the bounded context name",
-                        default="backoffice",
+                subquestions=ConditionalQuestion(
+                    base_question=BooleanQuestion(
+                        key="specify_bounded_context",
+                        message="Do you want to specify your first bounded context?",
+                        default=True,
                     ),
-                    FreeTextQuestion(
-                        key="aggregate_name",
-                        message="Enter the aggregate name",
-                        default="user",
-                    ),
-                ],
+                    subquestions=[
+                        FreeTextQuestion(
+                            key="bounded_context",
+                            message="Enter the bounded context name",
+                            default="backoffice",
+                        ),
+                        FreeTextQuestion(
+                            key="aggregate_name",
+                            message="Enter the aggregate name",
+                            default="user",
+                        ),
+                    ],
+                    condition=True,
+                ),
                 condition=TemplateTypes.DDD,
             ),
         ]

{instant_python-0.1.1 → instant_python-0.2.0}/instant_python/question_prompter/user_requirements.py

@@ -20,6 +20,7 @@ class UserRequirements:
     git_email: str = field(default_factory=str)
     git_user_name: str = field(default_factory=str)
     dependencies: list[str] = field(default_factory=list)
+    specify_bounded_context: bool = field(default=False)
     bounded_context: str = field(default_factory=str)
     aggregate_name: str = field(default_factory=str)
     built_in_features: list[str] = field(default_factory=list)

{instant_python-0.1.1 → instant_python-0.2.0}/instant_python/templates/boilerplate/event_bus/domain_event_json_deserializer.py

@@ -5,8 +5,8 @@ from {{ source_name }}.{{ template_domain_import }}.event.domain_event import Do
 from {{ source_name }}.{{ template_domain_import }}.event.domain_event_subscriber import (
     DomainEventSubscriber,
 )
-from {{ source_name }}.{{ template_domain_import }}.exceptions.domain_event_type_not_found import (
-    DomainEventTypeNotFound,
+from {{ source_name }}.{{ template_domain_import }}.exceptions.domain_event_type_not_found_error import (
+    DomainEventTypeNotFoundError,
 )
 
 
@@ -23,6 +23,6 @@ class DomainEventJsonDeserializer:
         event_class = self._events_mapping.get(content["data"]["type"])
 
         if not event_class:
-            raise DomainEventTypeNotFound(content["data"]["type"])
+            raise DomainEventTypeNotFoundError(content["data"]["type"])
 
         return event_class(**content["data"]["attributes"])

instant_python-0.2.0/instant_python/templates/boilerplate/event_bus/domain_event_subscriber.py

@@ -0,0 +1,34 @@
+{% set template_domain_import = "shared.domain"|compute_base_path(template) %}
+{% if pythono_version in ["3.12", "3.13"] %}
+from abc import ABC, abstractmethod
+
+from {{ source_name }}.{{ template_domain_import }}.event.domain_event import DomainEvent
+
+
+class DomainEventSubscriber[EventType: DomainEvent](ABC):
+    @staticmethod
+    @abstractmethod
+    def subscribed_to() -> list[type[EventType]]:
+        raise NotImplementedError
+
+    @abstractmethod
+    def on(self, event: EventType) -> None:
+        raise NotImplementedError
+{% else %}
+from abc import ABC, abstractmethod
+from typing import Generic, TypeVar
+
+from {{ source_name }}.{{ template_domain_import }}.event.domain_event import DomainEvent
+
+EventType = TypeVar("EventType", bound=DomainEvent)
+
+class DomainEventSubscriber(Generic[EventType], ABC):
+    @staticmethod
+    @abstractmethod
+    def subscribed_to() -> list[type[EventType]]:
+        raise NotImplementedError
+
+    @abstractmethod
+    def on(self, event: EventType) -> None:
+        raise NotImplementedError
+{% endif %}

{instant_python-0.1.1 → instant_python-0.2.0}/instant_python/templates/boilerplate/event_bus/event_bus.py

@@ -6,5 +6,5 @@ from {{ source_name }}.{{ template_domain_import }}.event.domain_event import Do
 
 class EventBus(ABC):
     @abstractmethod
-    def publish(self, events: list[DomainEvent]) -> None:
+    async def publish(self, events: list[DomainEvent]) -> None:
         raise NotImplementedError

{instant_python-0.1.1 → instant_python-0.2.0}/instant_python/templates/boilerplate/exceptions/domain_event_type_not_found_error.py

@@ -2,7 +2,7 @@
 from {{ source_name }}.{{ template_domain_import }}.exceptions.domain_error import DomainError
 
 
-class DomainEventTypeNotFound(DomainError):
+class DomainEventTypeNotFoundError(DomainError):
 	def __init__(self, name: str) -> None:
 		self._message = f"Event type {name} not found among subscriber."
 		self._type = "domain_event_type_not_found"

instant_python-0.2.0/instant_python/templates/boilerplate/exceptions/rabbit_mq_connection_not_established_error.py

@@ -0,0 +1,17 @@
+{% set template_domain_import = "shared.domain"|compute_base_path(template) %}
+from {{ source_name }}.{{ template_domain_import }}.exceptions.domain_error import DomainError
+
+
+class RabbitMqConnectionNotEstablishedError(DomainError):
+	def __init__(self) -> None:
+		self._message = "RabbitMQ connection not established."
+		self._type = "rabbit_mq_connection"
+		super().__init__(self._message)
+
+	@property
+	def type(self) -> str:
+		return self._type
+
+	@property
+	def message(self) -> str:
+		return self._message

{instant_python-0.1.1 → instant_python-0.2.0}/instant_python/templates/boilerplate/persistence/synchronous/sqlalchemy_repository.py

@@ -6,7 +6,7 @@ from typing import TypeVar
 from typing import TypeVar, Generic
 {% endif %}
 
-from {{ source_name }}.{{ template_domain_import }}.value_objects.uuid import Uuid
+from {{ source_name }}.{{ template_domain_import }}.value_object.uuid import Uuid
 from {{ source_name }}.{{ template_infra_import }}.persistence.sqlalchemy.base import Base
 from {{ source_name }}.{{ template_infra_import }}.persistence.sqlalchemy.session_maker import (
 	SessionMaker,

{instant_python-0.1.1 → instant_python-0.2.0}/instant_python/templates/boilerplate/value_object/int_value_object.py

@@ -2,7 +2,7 @@
 from {{ source_name }}.{{ template_domain_import }}.exceptions.invalid_negative_value_error import (
 	InvalidNegativeValueError,
 )
-from {{ source_name }}.{{ template_domain_import }}.value_objects.value_object import ValueObject
+from {{ source_name }}.{{ template_domain_import }}.value_object.value_object import ValueObject
 
 
 class IntValueObject(ValueObject[int]):

{instant_python-0.1.1 → instant_python-0.2.0}/instant_python/templates/boilerplate/value_object/string_value_object.py

@@ -5,7 +5,7 @@ from {{ source_name }}.{{ template_domain_import }}.exceptions.incorrect_value_t
 from {{ source_name }}.{{ template_domain_import }}.exceptions.required_value_error import (
     RequiredValueError,
 )
-from {{ source_name }}.{{ template_domain_import }}.value_objects.value_object import ValueObject
+from {{ source_name }}.{{ template_domain_import }}.value_object.value_object import ValueObject
 
 
 class StringValueObject(ValueObject[str]):

{instant_python-0.1.1 → instant_python-0.2.0}/instant_python/templates/boilerplate/value_object/uuid.py

@@ -4,7 +4,7 @@ from uuid import UUID
 from {{ source_name }}.{{ template_domain_import }}.exceptions.required_value_error import (
     RequiredValueError,
 )
-from {{ source_name }}.{{ template_domain_import }}.value_objects.value_object import ValueObject
+from {{ source_name }}.{{ template_domain_import }}.value_object.value_object import ValueObject
 
 
 class Uuid(ValueObject[str]):

{instant_python-0.1.1 → instant_python-0.2.0}/instant_python/templates/project_structure/clean_architecture/source.yml.j2

@@ -36,13 +36,13 @@
         {% if "event_bus" in built_in_features %}
         {{ macros.include_and_indent("project_structure/event_bus_infra.yml.j2", 8) }}
         {% endif %}
-        {% if "logger" in built_in_features %}
+        {% if ["logger", "fastapi_application"] | is_in(built_in_features) %}
         {{ macros.include_and_indent("project_structure/logger.yml.j2", 8) }}
         {% endif %}
         {% if "async_sqlalchemy" in built_in_features %}
         {{ macros.include_and_indent("project_structure/async_sqlalchemy.yml.j2", 8) }}
         {% endif %}
-        {% if "async_alembic" in built_in_features %}
+        {% if ["async_alembic", "fastapi_application"] | is_in(built_in_features) %}
         {{ macros.include_and_indent("project_structure/alembic_migrator.yml.j2", 8) }}
         {% endif %}
         {% if "fastapi_application" in built_in_features %}

{instant_python-0.1.1 → instant_python-0.2.0}/instant_python/templates/project_structure/domain_driven_design/source.yml.j2

@@ -38,13 +38,13 @@
             {% if "event_bus" in built_in_features %}
             {{ macros.include_and_indent("project_structure/event_bus_infra.yml.j2", 12) }}
             {% endif %}
-            {% if "logger" in built_in_features %}
+            {% if ["logger", "fastapi_application"] | is_in(built_in_features) %}
             {{ macros.include_and_indent("project_structure/logger.yml.j2", 12) }}
             {% endif %}
             {% if "async_sqlalchemy" in built_in_features %}
             {{ macros.include_and_indent("project_structure/async_sqlalchemy.yml.j2", 12) }}
             {% endif %}
-            {% if "async_alembic" in built_in_features %}
+            {% if ["async_alembic", "fastapi_application"] | is_in(built_in_features) %}
             {{ macros.include_and_indent("project_structure/alembic_migrator.yml.j2", 12) }}
             {% endif %}
             {% if "fastapi_application" in built_in_features %}
@@ -52,4 +52,6 @@
             {% endif %}
       {% endif %}
       {% endif %}
-    {{ macros.include_and_indent("project_structure/domain_driven_design/bounded_context.yml.j2", 4) }}
+    {% if specify_bounded_context %}
+    {{ macros.include_and_indent("project_structure/domain_driven_design/bounded_context.yml.j2", 4) }}
+    {% endig %}

{instant_python-0.1.1 → instant_python-0.2.0}/instant_python/templates/project_structure/domain_driven_design/test.yml.j2

@@ -23,4 +23,6 @@
               type: file
               extension: .py
         {% endif %}
+    {% if specify_bounded_context %}
     {{ macros.include_and_indent("project_structure/domain_driven_design/bounded_context.yml.j2", 4) }}
+    {% endig %}

{instant_python-0.1.1 → instant_python-0.2.0}/instant_python/templates/project_structure/event_bus_domain.yml.j2

@@ -22,5 +22,8 @@
   python: True
   children:
     - name: exceptions/domain_event_type_not_found_error
+      type: file
+      extension: .py
+    - name: exceptions/rabbit_mq_connection_not_established_error
       type: file
       extension: .py

{instant_python-0.1.1 → instant_python-0.2.0}/instant_python/templates/project_structure/standard_project/source.yml.j2

@@ -14,13 +14,13 @@
     {% if "synchronous_sqlalchemy" in built_in_features %}
     {{ macros.include_and_indent("project_structure/synchronous_sqlalchemy.yml.j2", 4) }}
     {% endif %}
-    {% if "logger" in built_in_features %}
+    {% if ["logger", "fastapi_application"] | is_in(built_in_features) %}
     {{ macros.include_and_indent("project_structure/logger.yml.j2", 4) }}
     {% endif %}
     {% if "async_sqlalchemy" in built_in_features %}
     {{ macros.include_and_indent("project_structure/async_sqlalchemy.yml.j2", 4) }}
     {% endif %}
-    {% if "async_alembic" in built_in_features %}
+    {% if ["async_alembic", "fastapi_application"] | is_in(built_in_features) %}
     {{ macros.include_and_indent("project_structure/alembic_migrator.yml.j2", 4) }}
     {% endif %}
     {% if "fastapi_application" in built_in_features %}

{instant_python-0.1.1 → instant_python-0.2.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "instant-python"
-version = "0.1.1"
+version = "0.2.0"
 description = "Python automatic project generator"
 readme = "README.md"
 license = { file = "LICENSE" }

{instant_python-0.1.1 → instant_python-0.2.0}/uv.lock

@@ -240,7 +240,7 @@ wheels = [
 
 [[package]]
 name = "instant-python"
-version = "0.1.1"
+version = "0.2.0"
 source = { editable = "." }
 dependencies = [
     { name = "jinja2" },

instant_python-0.1.1/instant_python/templates/boilerplate/event_bus/domain_event_subscriber.py

@@ -1,15 +0,0 @@
-{% set template_domain_import = "shared.domain"|compute_base_path(template) %}
-from abc import ABC, abstractmethod
-
-from {{ source_name }}.{{ template_domain_import }}.event.domain_event import DomainEvent
-
-
-class DomainEventSubscriber[EventType: DomainEvent](ABC):
-    @staticmethod
-    @abstractmethod
-    def subscribed_to() -> list[type[EventType]]:
-        raise NotImplementedError
-
-    @abstractmethod
-    def on(self, event: EventType) -> None:
-        raise NotImplementedError