instant-python 0.0.1__py3-none-any.whl

instant_python/templates/boilerplate/scripts/create_aggregate.py

@@ -0,0 +1,33 @@
+from pathlib import Path
+
+def create_package_structure(base_dir: str, context: str, aggregate: str) -> None:
+	"""Create the folder structure and __init__.py files for the given context and aggregate."""
+	context_base_path = Path(base_dir, "contexts", context)
+	aggregate_base_path = context_base_path / aggregate
+
+	dirs_to_create = [
+		context_base_path,
+		aggregate_base_path,
+		aggregate_base_path / "application",
+		aggregate_base_path / "domain",
+		aggregate_base_path / "infra",
+	]
+
+	for directory in dirs_to_create:
+		directory.mkdir(parents=True, exist_ok=True)
+		init_file = directory / "__init__.py"
+		if not init_file.exists():
+			init_file.touch()
+
+def main() -> None:
+	context = input("Enter the name of the bounded context: ").strip()
+	aggregate = input("Enter the name of the new aggregate: ").strip()
+
+	create_package_structure("instant_python", context, aggregate)
+	create_package_structure("tests", context, aggregate)
+
+	print(f"Successfully created the aggregate '{aggregate}' under context '{context}'.")
+
+
+if __name__ == "__main__":
+	main()

instant_python/templates/boilerplate/scripts/insert_template.py

@@ -0,0 +1,90 @@
+#!/usr/bin/env python
+import sys
+from pathlib import Path
+
+from scripts.templates.aggregate_root_template import aggregate_root_template
+from scripts.templates.exceptions.incorrect_value_error_template import incorrect_value_type_error_template
+from scripts.templates.exceptions.required_value_error_template import required_value_error_template
+from scripts.templates.exceptions.invalid_negative_value_error_template import invalid_negative_value_error_template
+from scripts.templates.value_objects.string_value_object_template import string_value_object_template
+from scripts.templates.value_objects.uuid_template import uuid_template
+from scripts.templates.value_objects.value_object_template import value_object_template
+from scripts.templates.value_objects.int_value_object_template import int_value_object_template
+from scripts.templates.events.domain_event_template import domain_event_template
+from scripts.templates.events.domain_event_subscriber_template import domain_event_subscriber_template
+from scripts.templates.events.event_bus_template import event_bus_template
+from scripts.templates.events.exchange_type_template import exchange_type_template
+from scripts.templates.events.rabbit_mq_configurer_template import rabbit_mq_configurer_template
+from scripts.templates.events.rabbit_mq_connection_template import rabbit_mq_connection_template
+from scripts.templates.events.rabbit_mq_consumer_template import rabbit_mq_consumer_template
+from scripts.templates.events.rabbit_mq_event_bus_template import rabbit_mq_event_bus_template
+from scripts.templates.events.rabbit_mq_queue_formatter_template import rabbit_mq_queue_formatter_template
+from scripts.templates.events.rabbit_mq_settings_template import rabbit_mq_settings_template
+from scripts.templates.events.domain_event_json_deserializer_template import domain_event_json_deserializer_template
+from scripts.templates.events.domain_event_json_serializer_template import domain_event_json_serializer_template
+
+
+TEMPLATES = {
+	"value_object": value_object_template,
+	"string_value_object": string_value_object_template,
+	"int_value_object": int_value_object_template,
+	"uuid": uuid_template,
+	"incorrect_value": incorrect_value_type_error_template,
+	"required_value": required_value_error_template,
+	"invalid_negative_value": invalid_negative_value_error_template,
+	"domain_event": domain_event_template,
+	"domain_event_subscriber": domain_event_subscriber_template,
+	"event_bus": event_bus_template,
+	"exchange_type": exchange_type_template,
+	"aggregate_root": aggregate_root_template,
+	"rabbit_mq_configurer": rabbit_mq_configurer_template,
+	"rabbit_mq_connection": rabbit_mq_connection_template,
+	"rabbit_mq_consumer": rabbit_mq_consumer_template,
+	"rabbit_mq_event_bus": rabbit_mq_event_bus_template,
+	"rabbit_mq_queue_formatter": rabbit_mq_queue_formatter_template,
+	"rabbit_mq_settings": rabbit_mq_settings_template,
+	"domain_event_json_deserializer": domain_event_json_deserializer_template,
+	"domain_event_json_serializer": domain_event_json_serializer_template,
+}
+
+
+def main() -> None:
+	list_available_templates()
+	template_name = input("Enter the name of the template you want to insert: ")
+	ensure_template_exists(template_name)
+
+	user_path = input("Enter the path where template should be created: ")
+	folder_path = generate_folder_path(Path(user_path))
+	write_content_at(folder_path, template_name)
+
+
+def list_available_templates() -> None:
+    print(f"Available templates: {', '.join(TEMPLATES.keys())}")
+
+
+def ensure_template_exists(template_name: str) -> None:
+	if template_name not in TEMPLATES:
+		print(f"Error: Template '{template_name}' not found.")
+		list_available_templates()
+		sys.exit(1)
+
+
+def write_content_at(folder_path: Path, template_name: str) -> None:
+	file_name = f"{template_name.replace('_template', '')}.py"
+	file_path = folder_path / file_name
+
+	with open(file_path, "w") as file:
+		file.write(TEMPLATES[template_name])
+	print(f"Template {template_name} created at {file_path}")
+
+
+def generate_folder_path(user_path: Path) -> Path:
+	project_root = Path(__file__).resolve().parents[1]
+	folder_path =  project_root / user_path
+	folder_path.mkdir(parents=True, exist_ok=True)
+	print(f"Folder created at: {folder_path}")
+	return folder_path
+
+
+if __name__ == "__main__":
+	main()

instant_python/templates/boilerplate/scripts/integration.sh

@@ -0,0 +1,39 @@
+#!/bin/bash
+
+function get_bounded_contexts_with_changes {
+  changed_files=$(git diff --name-only HEAD)
+  bounded_contexts=$(echo "$changed_files" | grep -E 'instant_python/contexts/([^/]*/)*(infra)' | sed -E 's|instant_python/contexts/([^/]*)/.*|\1|' | sort -u)
+  echo "$bounded_contexts"
+}
+
+function has_bounded_contexts {
+  local contexts="$1"
+
+  if [[ -z "$contexts" ]]; then
+    echo "No changes detected in infra folder of any bounded context."
+    return 1
+  fi
+
+  return 0
+}
+
+function run_tests {
+  local contexts="$1"
+
+  for context in $contexts; do
+    echo "Running integration tests for bounded context: $context"
+    infra_folders=$(find tests/contexts/"$context" -type d -name "infra")
+    {{ dependency_manager }} run pytest $infra_folders -ra
+  done
+}
+
+function main {
+  local bounded_contexts
+  bounded_contexts=$(get_bounded_contexts_with_changes)
+
+  if has_bounded_contexts "$bounded_contexts"; then
+    run_tests "$bounded_contexts"
+  fi
+}
+
+main

instant_python/templates/boilerplate/scripts/local_setup.sh

@@ -0,0 +1,15 @@
+#!/bin/bash
+set -e
+
+function main {
+  echo "Installing git hooks..."
+  redirect_hooks_location
+  echo "Git hooks installed."
+}
+
+function redirect_hooks_location {
+  # Default location for git hooks is .git/hooks
+  git config core.hooksPath scripts/hooks
+}
+
+main

instant_python/templates/boilerplate/scripts/makefile

@@ -0,0 +1,137 @@
+.DEFAULT_GOAL := help
+
+.PHONY: help
+help:  ## Show this help.
+	@grep -E '^[a-zA-Z_-]+:.*?## ' $(firstword $(MAKEFILE_LIST)) | \
+			awk 'BEGIN {FS = ":.*## "}; {printf "%-30s %s\n", $$1, $$2}'
+
+.PHONY: test
+test:  ## Run all test.
+	@{{ dependency_manager }} run pytest -n 0 tests -ra
+
+.PHONY: unit
+unit:  ## Run unit test in changed files.
+	@scripts/tests/unit.sh
+
+.PHONY: integration
+integration:  ## Run integration test in changed files.
+	@scripts/tests/integration.sh
+
+.PHONY: all-unit
+all-unit:  ## Run all unit test.
+	@{{ dependency_manager }} run pytest -n auto -m "unit" -ra
+
+.PHONY: all-integration
+all-integration:  ## Run all integration test.
+	@{{ dependency_manager }} run pytest -m "integration" -ra
+
+.PHONY: all-acceptance
+all-acceptance:  ## Run all acceptance test.
+	@{{ dependency_manager }} run pytest -m "acceptance" -ra
+
+.PHONY: coverage
+coverage:  ## Run all test with coverage.
+	@{{ dependency_manager }} run coverage run --branch -m pytest tests
+	@{{ dependency_manager }} run coverage html
+	@$(BROWSER) htmlcov/index.html
+
+.PHONY: local-setup
+local-setup:  ## Setup git hooks and install dependencies.
+	@scripts/local_setup.sh
+	@make install
+
+.PHONY: install
+install:  ## Install dependencies.
+	{% if dependency_manager == "uv" %}
+	@uv sync --all-groups
+	{% elif dependency_manager == "pdm" %}
+	@pdm install
+	{% endif %}
+
+.PHONY: update
+update:  ## Update dependencies.
+	{% if dependency_manager == "uv" %}
+	@uv sync --upgrade
+	{% elif dependency_manager == "pdm" %}
+	@pdm update
+	{% endif %}
+
+.PHONY: add-dep
+add-dep:  ## Add a new dependency.
+	@scripts/add_dependency.sh
+
+.PHONY: remove-dep
+remove-dep:  ## Remove a dependency.
+	@scripts/remove_dependency.sh
+
+.PHONY: check-typing
+check-typing:  ## Run mypy type checking.
+	@{{ dependency_manager }} run mypy
+
+.PHONY: check-lint
+check-lint:  ## Run ruff linting check.
+	{% if dependency_manager == "pdm" %}
+	@pdm run ruff check src tests
+	{% elif dependency_manager == "uv" %}
+	@uvx ruff check src tests
+	{% endif %}
+
+.PHONY: lint
+lint:  ## Apply ruff linting fix.
+	{% if dependency_manager == "pdm" %}
+	@pdm run ruff check --fix src tests
+	{% elif dependency_manager == "uv" %}
+	@uvx ruff check --fix src tests
+	{% endif %}
+
+.PHONY: check-format
+check-format:  ## Run ruff format check.
+	{% if dependency_manager == "pdm" %}
+	@pdm run ruff format --check src tests
+	{% elif dependency_manager == "uv" %}
+	@uvx ruff format --check src tests
+	{% endif %}
+
+.PHONY: format
+format:  ## Apply ruff format fix.
+	{% if dependency_manager == "pdm" %}
+	@pdm run ruff format src tests
+	{% elif dependency_manager == "uv" %}
+	@uvx ruff format src tests
+	{% endif %}
+
+.PHONY: pre-commit
+pre-commit: check-typing check-lint check-format all-unit ## Run pre-commit checks.
+
+.PHONY: pre-push
+pre-push:  all-integration all-acceptance ## Run pre-push checks.
+
+.PHONY: watch
+watch:  ## Run all test with every change.
+	@{{ dependency_manager }} run ptw --runner "pytest -n auto tests -ra"
+
+.PHONY: insert-template
+insert-template:  ## Insert a template class among the existing ones.
+	@{{ dependency_manager }} run python -m scripts.insert_template
+
+.PHONY: create-aggregate
+create-aggregate:  ## Create a new aggregate inside contexts folder.
+	@{{ dependency_manager }} run python -m scripts.create_aggregate
+
+.PHONY: show
+show:  ## Show installed dependencies.
+	{% if dependency_manager == "pdm" %}
+	@pdm list
+	{% elif dependency_manager == "uv" %}
+	@uv tree
+	{% endif %}
+
+.PHONY: search
+search:  ## Show package details.
+	@read -p "Enter package name to search: " package;\
+	{% if dependency_manager == "pdm" %}
+	pdm show $$package
+	{% elif dependency_manager == "uv" %}
+	uv pip show $$package
+	{% endif %}
+

instant_python/templates/boilerplate/scripts/post-merge

@@ -0,0 +1,11 @@
+#!/bin/bash
+# https://git-scm.com/docs/githooks#_post_merge
+
+changed_files="$(git diff-tree -r --name-only --no-commit-id HEAD@{1} HEAD)"
+
+detect_changes() {
+  files_to_search="Dockerfile\|pyproject.toml\|poetry.lock"
+	echo "$changed_files" | grep --quiet $files_to_search && echo " * changes detected in $1" && echo " * running $2" && make build && make install
+}
+
+detect_changes

instant_python/templates/boilerplate/scripts/pre-commit

@@ -0,0 +1,4 @@
+#!/bin/bash
+set -e
+
+make pre-commit

instant_python/templates/boilerplate/scripts/pre-push

@@ -0,0 +1,6 @@
+#!/bin/bash
+set -e
+
+exec < /dev/tty
+
+make pre-push

instant_python/templates/boilerplate/scripts/remove_dependency.sh

@@ -0,0 +1,36 @@
+#!/bin/bash
+
+read -p "Dependency to remove: " dependency
+read -p "Is $dependency a dev dependency? (y/n): " is_dev
+read -p "Does $dependency belong to a group? (y/n): " belongs_to_group
+
+{% if dependency_manager == "pdm" -%}
+
+dev_flag=""
+group_flag=""
+
+if [ "$is_dev" == "y" ]; then
+  dev_flag="-d"
+fi
+
+if [ "$belongs_to_group" == "y" ]; then
+  read -p "Group name: " group_name
+  group_flag="-G $group_name"
+fi
+
+pdm remove $dev_flag $group_flag $dependency
+
+{%- elif dependency_manager == "uv" -%}
+flag=""
+
+if [ "$is_dev" == "y" ]; then
+  flag="--dev"
+fi
+
+if [ "$belongs_to_group" == "y" ]; then
+  read -p "Group name: " group_name
+  flag="--group $group_name"
+fi
+
+uv remove $flag $dependency
+{%- endif %}

instant_python/templates/boilerplate/scripts/unit.sh

@@ -0,0 +1,40 @@
+#!/bin/bash
+
+function get_bounded_contexts_with_changes {
+  changed_files=$(git diff --name-only HEAD)
+  bounded_contexts=$(echo "$changed_files" | grep -E 'instant_python/contexts/([^/]*/)*(application|domain)' | sed -E 's|instant_python/contexts/([^/]*)/.*|\1|' | sort -u)
+  echo "$bounded_contexts"
+}
+
+function has_bounded_contexts {
+  local contexts="$1"
+
+  if [[ -z "$contexts" ]]; then
+    echo "No changes detected in application or domain folders of any bounded context."
+    return 1
+  fi
+
+  return 0
+}
+
+function run_tests {
+  local contexts="$1"
+
+  for context in $contexts; do
+    echo "Running application and domain tests for: $context"
+    application_folders=$(find tests/contexts/"$context" -type d -name "application")
+    domain_folders=$(find tests/contexts/"$context" -type d -name "domain")
+    {{ dependency_manager }} run pytest -n auto $application_folders $domain_folders -ra
+  done
+}
+
+function main {
+  local bounded_contexts
+  bounded_contexts=$(get_bounded_contexts_with_changes)
+
+  if has_bounded_contexts "$bounded_contexts"; then
+    run_tests "$bounded_contexts"
+  fi
+}
+
+main

instant_python/templates/boilerplate/value_object/int_value_object.py

@@ -0,0 +1,11 @@
+{% set template_domain_import = "shared.domain"|compute_base_path(template) %}
+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
+
+
+class IntValueObject(ValueObject[int]):
+	def _validate(self, value: int) -> None:
+		if value < 0:
+			raise InvalidNegativeValueError(value)

instant_python/templates/boilerplate/value_object/string_value_object.py

@@ -0,0 +1,19 @@
+{% set template_domain_import = "shared.domain"|compute_base_path(template) %}
+from {{ source_name }}.{{ template_domain_import }}.exceptions.incorrect_value_type_error import (
+    IncorrectValueTypeError,
+)
+from {{ source_name }}.{{ template_domain_import }}.exceptions.required_value_error import (
+    RequiredValueError,
+)
+from {{ source_name }}.{{ template_domain_import }}.value_objects.value_object import ValueObject
+
+
+class StringValueObject(ValueObject[str]):
+    def __init__(self, value: str) -> None:
+        super().__init__(value)
+
+    def _validate(self, value: str) -> None:
+        if value is None:
+            raise RequiredValueError
+        if not isinstance(value, str):
+            raise IncorrectValueTypeError

instant_python/templates/boilerplate/value_object/uuid.py

@@ -0,0 +1,17 @@
+{% set template_domain_import = "shared.domain"|compute_base_path(template) %}
+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
+
+
+class Uuid(ValueObject[str]):
+    def __init__(self, value: str) -> None:
+        super().__init__(value)
+
+    def _validate(self, value: str) -> None:
+        if value is None:
+            raise RequiredValueError
+        UUID(value)

instant_python/templates/boilerplate/value_object/value_object.py

@@ -0,0 +1,21 @@
+from abc import ABC, abstractmethod
+from typing import override
+
+
+class ValueObject[T](ABC):
+	_value: T
+
+	def __init__(self, value: T) -> None:
+		self._validate(value)
+		self._value = value
+
+	@abstractmethod
+	def _validate(self, value: T) -> None: ...
+
+	@property
+	def value(self) -> T:
+		return self._value
+
+	@override
+	def __eq__(self, other: "ValueObject[T]") -> bool:
+		return self.value == other.value

instant_python/templates/project_structure/alembic_migrator.yml.j2

@@ -0,0 +1,3 @@
+- name: persistence/alembic_migrator
+  type: file
+  extension: .py

instant_python/templates/project_structure/async_alembic.yml.j2

@@ -0,0 +1,20 @@
+- name: persistence/async/alembic
+  type: file
+  extension: .ini
+- name: migrations
+  type: directory
+  children:
+    - name: versions
+      type: directory
+    - name: persistence/async/README
+      type: file
+      extension: .md
+    - name: persistence/async/env
+      type: file
+      extension: .py
+    - name: persistence/async/models_metadata
+      type: file
+      extension: .py
+    - name: persistence/async/script
+      type: file
+      extension: .py.mako

instant_python/templates/project_structure/async_sqlalchemy.yml.j2

@@ -0,0 +1,17 @@
+- name: persistence
+  type: directory
+  python: True
+  children:
+    - name: sqlalchemy
+      type: directory
+      python: True
+      children:
+        - name: persistence/base
+          type: file
+          extension: .py
+        - name: persistence/async/sqlalchemy_repository
+          type: file
+          extension: .py
+        - name: persistence/async/postgres_settings
+          type: file
+          extension: .py

instant_python/templates/project_structure/clean_architecture/main_structure.yml.j2

@@ -0,0 +1,25 @@
+{% import "project_structure/macros.j2" as macros with context %}
+root:
+  {{ macros.include_and_indent("project_structure/clean_architecture/source.yml.j2", 2) }}
+  {{ macros.include_and_indent("project_structure/clean_architecture/test.yml.j2", 2) }}
+  {% if "github_actions" in built_in_features %}
+  {{ macros.include_and_indent("project_structure/github_action.yml.j2", 2) }}
+  {% endif %}
+  {% if "makefile" in built_in_features %}
+  {{ macros.include_and_indent("project_structure/makefile.yml.j2", 2) }}
+  {% endif %}
+  {{ macros.include_and_indent("project_structure/pyproject.yml.j2", 2) }}
+  {% if git %}
+  {{ macros.include_and_indent("project_structure/gitignore.yml.j2", 2) }}
+  {% endif %}
+  {{ macros.include_and_indent("project_structure/python_version.yml.j2", 2) }}
+  {% if "pytest" in dependencies %}
+  {{ macros.include_and_indent("project_structure/pytest.yml.j2", 2) }}
+  {% endif %}
+  {% if "mypy" in dependencies %}
+  {{ macros.include_and_indent("project_structure/mypy.yml.j2", 2) }}
+  {% endif %}
+  {{ macros.include_and_indent("project_structure/license.yml.j2", 2) }}
+  {% if "async_alembic" in built_in_features %}
+  {{ macros.include_and_indent("project_structure/async_alembic.yml.j2", 2) }}
+  {% endif %}

instant_python/templates/project_structure/clean_architecture/source.yml.j2

@@ -0,0 +1,51 @@
+{% import "project_structure/macros.j2" as macros with context %}
+- name: {{ source_name }}
+  type: directory
+  python: True
+  children:
+    - name: delivery
+      type: directory
+      python: True
+      {% if "fastapi_application" in built_in_features %}
+      children:
+        {{ macros.include_and_indent("project_structure/fastapi_app.yml.j2", 8) }}
+      {% endif %}
+    - name: domain
+      type: directory
+      python: True
+      {% if ["value_objects", "event_bus"] | is_in(built_in_features) %}
+      children:
+        {% if "value_objects" in built_in_features %}
+        {{ macros.include_and_indent("project_structure/value_objects.yml.j2", 8) }}
+        {% endif %}
+        {% if "event_bus" in built_in_features %}
+        {{ macros.include_and_indent("project_structure/event_bus_domain.yml.j2", 8) }}
+        {% endif %}
+      {% endif %}
+    - name: application
+      type: directory
+      python: True
+    - name: infra
+      type: directory
+      python: True
+      {% if ["synchronous_sqlalchemy", "event_bus", "logger", "async_sqlalchemy", "async_alembic", "fastapi_application"] | is_in(built_in_features) %}
+      children:
+        {% if "synchronous_sqlalchemy" in built_in_features %}
+        {{ macros.include_and_indent("project_structure/synchronous_sqlalchemy.yml.j2", 8) }}
+        {% endif %}
+        {% 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 %}
+        {{ 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 %}
+        {{ macros.include_and_indent("project_structure/alembic_migrator.yml.j2", 8) }}
+        {% endif %}
+        {% if "fastapi_application" in built_in_features %}
+        {{ macros.include_and_indent("project_structure/fastapi_infra.yml.j2", 8) }}
+        {% endif %}
+      {% endif %}

instant_python/templates/project_structure/clean_architecture/test.yml.j2

@@ -0,0 +1,23 @@
+{% import "project_structure/macros.j2" as macros with context %}
+- name: test
+  type: directory
+  python: True
+  children:
+    - name: unit
+      type: directory
+      python: True
+      {% if "event_bus" in built_in_features %}
+      children:
+        - name: event_bus/mock_event_bus
+          type: file
+          extension: .py
+      {% endif %}
+    - name: integration
+      type: directory
+      python: True
+    - name: acceptance
+      type: directory
+      python: True
+    - name: random_generator
+      type: file
+      extension: .py

instant_python/templates/project_structure/domain_driven_design/bounded_context.yml.j2

@@ -0,0 +1,20 @@
+- name: {{ bounded_context }}
+  type: directory
+  python: True
+  children:
+    - name: shared
+      type: directory
+      python: True
+    - name: {{ aggregate_name }}
+      type: directory
+      python: True
+      children:
+        - name: application
+          type: directory
+          python: True
+        - name: domain
+          type: directory
+          python: True
+        - name: infrastructure
+          type: directory
+          python: True