instant-python 0.0.1__py3-none-any.whl

instant_python/templates/boilerplate/github/test_lint.yml

@@ -0,0 +1,36 @@
+name: Pass checks and tests
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+permissions:
+  contents: read
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+      - uses: ./.github/actions/python_setup
+      - run: make check-lint
+  format:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+      - uses: ./.github/actions/python_setup
+      - run: make check-format
+  typing:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+      - uses: ./.github/actions/python_setup
+      - run: make check-typing
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+      - uses: ./.github/actions/python_setup
+      - run: make test

instant_python/templates/boilerplate/logger/json_formatter.py

@@ -0,0 +1,16 @@
+import json
+import logging
+
+
+class JSONFormatter(logging.Formatter):
+	def format(self, record: logging.LogRecord) -> str:
+		log_record = {
+			"time": self.formatTime(record, self.datefmt),
+			"level": record.levelname,
+			"name": record.name,
+			"message": record.getMessage(),
+		}
+		if hasattr(record, "extra"):
+			log_record["extra"] = record.extra
+
+		return json.dumps(log_record)

instant_python/templates/boilerplate/logger/logger.py

@@ -0,0 +1,39 @@
+{% set template_infra_import = "shared.infra"|compute_base_path(template) %}
+import logging
+from datetime import date
+from logging.handlers import TimedRotatingFileHandler
+from pathlib import Path
+
+from {{ source_name }}.{{ template_infra_import }}.log.json_formatter import JSONFormatter
+
+
+def create_file_handler(file_name: str, level: int) -> TimedRotatingFileHandler:
+	root_project_path = Path(__file__).parents[4]
+	log_folder = root_project_path / "logs"
+	log_folder.mkdir(parents=True, exist_ok=True)
+
+	file_handler = TimedRotatingFileHandler(
+		filename=f"{log_folder}/{file_name}_{date.today().isoformat()}.log",
+		when="midnight",
+		interval=1,
+		backupCount=7,
+		encoding="utf-8",
+	)
+	file_handler.setFormatter(JSONFormatter())
+	file_handler.setLevel(level)
+
+	return file_handler
+
+
+def create_logger(logger_name: str) -> logging.Logger:
+	logger = logging.getLogger(logger_name)
+	logger.setLevel(logging.DEBUG)
+
+	production_handler = create_file_handler(file_name="prod", level=logging.ERROR)
+	develop_handler = create_file_handler(file_name="dev", level=logging.DEBUG)
+
+	if not logger.handlers:
+		logger.addHandler(production_handler)
+		logger.addHandler(develop_handler)
+
+	return logger

instant_python/templates/boilerplate/mypy.ini

@@ -0,0 +1,41 @@
+[mypy]
+files = src, tests
+python_version = 3.13
+mypy_path = .
+disable_error_code = override,attr-defined
+check_untyped_defs = true
+disallow_any_explicit = false
+
+# None and Optional handling
+no_implicit_optional = true
+
+# Configuring warnings
+warn_redundant_casts = true
+warn_unused_ignores = false
+warn_no_return = true
+warn_return_any = true
+warn_unreachable = true
+
+# Miscellaneous strictness flags
+implicit_reexport = true
+strict_equality = true
+
+# Configuring error messages
+show_error_context = true
+show_column_numbers = true
+show_error_codes = true
+pretty = true
+show_absolute_path = false
+
+disallow_untyped_defs = true
+
+[mypy-expects.*]
+ignore_missing_imports = True
+[mypy-doublex.*]
+ignore_missing_imports = True
+[mypy-src.*]
+ignore_missing_imports = True
+[mypy-tests.*]
+disallow_untyped_defs = False
+[mypy-doublex_expects.*]
+ignore_missing_imports = True

instant_python/templates/boilerplate/persistence/alembic_migrator.py

@@ -0,0 +1,20 @@
+{% set template_infra_import = "shared.infra"|compute_base_path(template) %}
+import asyncio
+
+from {{ source_name }}.{{ template_infra_import }}.persistence.sqlalchemy.postgres_settings import PostgresSettings
+from alembic import command
+from alembic.config import Config
+
+
+class AlembicMigrator:
+	def __init__(self) -> None:
+		self._settings = PostgresSettings()  # type: ignore
+		self._alembic_config = Config()
+
+	async def migrate(self) -> None:
+		self._alembic_config.set_main_option(
+			"sqlalchemy.url", self._settings.postgres_url
+		)
+		self._alembic_config.set_main_option("script_location", "migrations")
+		loop = asyncio.get_event_loop()
+		await loop.run_in_executor(None, command.upgrade, self._alembic_config, "head")  # type: ignore

instant_python/templates/boilerplate/persistence/async/README.md

@@ -0,0 +1 @@
+Generic single-database configuration with an async dbapi.

instant_python/templates/boilerplate/persistence/async/alembic.ini

@@ -0,0 +1,124 @@
+# A generic, single database configuration.
+
+[alembic]
+# path to migration scripts
+# Use forward slashes (/) also on windows to provide an os agnostic path
+script_location = migrations
+
+# template used to generate migration file names; The default value is %%(rev)s_%%(slug)s
+# Uncomment the line below if you want the files to be prepended with date and time
+# see https://alembic.sqlalchemy.org/en/latest/tutorial.html#editing-the-ini-file
+# for all available tokens
+file_template = %%(year)d_%%(month).2d_%%(day).2d_%%(hour).2d%%(minute).2d-%%(rev)s_%%(slug)s
+
+# sys.path path, will be prepended to sys.path if present.
+# defaults to the current working directory.
+prepend_sys_path = .
+
+# timezone to use when rendering the date within the migration file
+# as well as the filename.
+# If specified, requires the python>=3.9 or backports.zoneinfo library and tzdata library.
+# Any required deps can installed by adding `alembic[tz]` to the pip requirements
+# string value is passed to ZoneInfo()
+# leave blank for localtime
+# timezone =
+
+# max length of characters to apply to the "slug" field
+# truncate_slug_length = 40
+
+# set to 'true' to run the environment during
+# the 'revision' command, regardless of autogenerate
+# revision_environment = false
+
+# set to 'true' to allow .pyc and .pyo files without
+# a source .py file to be detected as revisions in the
+# versions/ directory
+# sourceless = false
+
+# version location specification; This defaults
+# to migrations/versions.  When using multiple version
+# directories, initial revisions must be specified with --version-path.
+# The path separator used here should be the separator specified by "version_path_separator" below.
+# version_locations = %(here)s/bar:%(here)s/bat:migrations/versions
+
+# version path separator; As mentioned above, this is the character used to split
+# version_locations. The default within new alembic.ini files is "os", which uses os.pathsep.
+# If this key is omitted entirely, it falls back to the legacy behavior of splitting on spaces and/or commas.
+# Valid values for version_path_separator are:
+#
+# version_path_separator = :
+# version_path_separator = ;
+# version_path_separator = space
+# version_path_separator = newline
+#
+# Use os.pathsep. Default configuration used for new projects.
+version_path_separator = os
+
+# set to 'true' to search source files recursively
+# in each "version_locations" directory
+# new in Alembic version 1.10
+# recursive_version_locations = false
+
+# the output encoding used when revision files
+# are written from script.py.mako
+# output_encoding = utf-8
+
+sqlalchemy.url = driver://user:pass@localhost/dbname
+
+
+[post_write_hooks]
+# post_write_hooks defines scripts or Python functions that are run
+# on newly generated revision scripts.  See the documentation for further
+# detail and examples
+
+# format using "black" - use the console_scripts runner, against the "black" entrypoint
+# hooks = black
+# black.type = console_scripts
+# black.entrypoint = black
+# black.options = -l 79 REVISION_SCRIPT_FILENAME
+
+# lint with attempts to fix using "ruff" - use the exec runner, execute a binary
+hooks = ruff_lint, ruff_format
+ruff_lint.type = exec
+ruff_lint.executable = %(here)s/.venv/bin/ruff
+ruff_lint.options = check --fix REVISION_SCRIPT_FILENAME
+
+# format with attempts to fix using "ruff" - use the exec runner, execute a binary
+ruff_format.type = exec
+ruff_format.executable = %(here)s/.venv/bin/ruff
+ruff_format.options = format REVISION_SCRIPT_FILENAME
+
+# Logging configuration
+[loggers]
+keys = root,sqlalchemy,alembic
+
+[handlers]
+keys = console
+
+[formatters]
+keys = generic
+
+[logger_root]
+level = WARNING
+handlers = console
+qualname =
+
+[logger_sqlalchemy]
+level = WARNING
+handlers =
+qualname = sqlalchemy.engine
+
+[logger_alembic]
+level = INFO
+handlers =
+qualname = alembic
+
+[handler_console]
+class = StreamHandler
+args = (sys.stderr,)
+level = NOTSET
+formatter = generic
+
+[formatter_generic]
+format = %(levelname)-5.5s [%(name)s] %(message)s
+datefmt = %H:%M:%S

instant_python/templates/boilerplate/persistence/async/async_engine_fixture.py

@@ -0,0 +1,21 @@
+{% set template_infra_import = "shared.infra"|compute_base_path(template) %}
+from collections.abc import AsyncGenerator
+import pytest
+from sqlalchemy.ext.asyncio import AsyncEngine, create_async_engine
+
+from {{ source_name }}.{{ template_infra_import }}.persistence.sqlalchemy.postgres_settings import PostgresSettings
+
+
+@pytest.fixture
+async def engine() -> AsyncGenerator[AsyncEngine]:
+	settings = PostgresSettings()  # type: ignore
+	engine = create_async_engine(settings.postgres_url)
+
+	async with engine.begin() as conn:
+		await conn.run_sync(EntityModel.metadata.create_all)
+
+	yield engine
+
+	async with engine.begin() as conn:
+		await conn.run_sync(EntityModel.metadata.drop_all)
+	await engine.dispose()

instant_python/templates/boilerplate/persistence/async/env.py

@@ -0,0 +1,95 @@
+{% set template_infra_import = "shared.infra"|compute_base_path(template) %}
+import asyncio
+from logging.config import fileConfig
+
+from alembic import context
+from sqlalchemy import pool
+from sqlalchemy.engine import Connection
+from sqlalchemy.ext.asyncio import async_engine_from_config
+
+from migrations.models_metadata import base
+from {{ source_name }}.{{ template_infra_import }}.persistence.sqlalchemy.postgres_settings import PostgresSettings
+
+# this is the Alembic Config object, which provides
+# access to the values within the .ini file in use.
+config = context.config
+
+settings = PostgresSettings()  # type: ignore
+config.set_main_option("sqlalchemy.url", settings.postgres_url)
+
+# Interpret the config file for Python logging.
+# This line sets up loggers basically.
+if config.config_file_name is not None:
+	fileConfig(config.config_file_name)
+
+# add your model's MetaData object here
+# for 'autogenerate' support
+# from myapp import mymodel
+# target_metadata = mymodel.Base.metadata
+target_metadata = base.metadata
+
+# other values from the config, defined by the needs of env.py,
+# can be acquired:
+# my_important_option = config.get_main_option("my_important_option")
+# ... etc.
+
+
+def run_migrations_offline() -> None:
+	"""Run migrations in 'offline' mode.
+
+	This configures the context with just a URL
+	and not an Engine, though an Engine is acceptable
+	here as well.  By skipping the Engine creation
+	we don't even need a DBAPI to be available.
+
+	Calls to context.execute() here emit the given string to the
+	script output.
+
+	"""
+	url = config.get_main_option("sqlalchemy.url")
+	context.configure(
+		url=url,
+		target_metadata=target_metadata,
+		literal_binds=True,
+		dialect_opts={"paramstyle": "named"},
+	)
+
+	with context.begin_transaction():
+		context.run_migrations()
+
+
+def do_run_migrations(connection: Connection) -> None:
+	context.configure(connection=connection, target_metadata=target_metadata)
+
+	with context.begin_transaction():
+		context.run_migrations()
+
+
+async def run_async_migrations() -> None:
+	"""In this scenario we need to create an Engine
+	and associate a connection with the context.
+
+	"""
+
+	connectable = async_engine_from_config(
+		config.get_section(config.config_ini_section, {}),
+		prefix="sqlalchemy.",
+		poolclass=pool.NullPool,
+	)
+
+	async with connectable.connect() as connection:
+		await connection.run_sync(do_run_migrations)
+
+	await connectable.dispose()
+
+
+def run_migrations_online() -> None:
+	"""Run migrations in 'online' mode."""
+
+	asyncio.run(run_async_migrations())
+
+
+if context.is_offline_mode():
+	run_migrations_offline()
+else:
+	run_migrations_online()

instant_python/templates/boilerplate/persistence/async/models_metadata.py

@@ -0,0 +1,11 @@
+"""
+This  module is needed for alembic to detect correctly all models of the project.
+
+When we import Base.metadata in the env.py file it will include all the models that inherit from it only if these models
+have already been imported. To keep the env.py file clean, we import the Base.metadata in this file and then import all the
+needed models.
+"""
+{% set template_infra_import = "shared.infra"|compute_base_path(template) %}
+from {{ source_name }}.{{ template_infra_import }}.persistence.sqlalchemy.base import Base
+
+base = Base

instant_python/templates/boilerplate/persistence/async/postgres_settings.py

@@ -0,0 +1,15 @@
+from pydantic import Field
+from pydantic_settings import BaseSettings, SettingsConfigDict
+
+
+class PostgresSettings(BaseSettings):
+	model_config = SettingsConfigDict(env_file=(".env", ".env.prod"), extra="ignore")
+	postgres_user: str = Field(alias="POSTGRES_USER")
+	postgres_password: str = Field(alias="POSTGRES_PASSWORD")
+	postgres_db: str = Field(alias="POSTGRES_DB")
+	postgres_host: str = Field(alias="POSTGRES_HOST")
+	postgres_port: str = Field(alias="POSTGRES_PORT")
+
+	@property
+	def postgres_url(self) -> str:
+		return f"postgresql+asyncpg://{self.postgres_user}:{self.postgres_password}@{self.postgres_host}:{self.postgres_port}/{self.postgres_db}"

instant_python/templates/boilerplate/persistence/async/script.py.mako

@@ -0,0 +1,26 @@
+"""${message}
+
+Revision ID: ${up_revision}
+Revises: ${down_revision | comma,n}
+Create Date: ${create_date}
+
+"""
+from typing import Sequence, Union
+
+from alembic import op
+import sqlalchemy as sa
+${imports if imports else ""}
+
+# revision identifiers, used by Alembic.
+revision: str = ${repr(up_revision)}
+down_revision: Union[str, None] = ${repr(down_revision)}
+branch_labels: Union[str, Sequence[str], None] = ${repr(branch_labels)}
+depends_on: Union[str, Sequence[str], None] = ${repr(depends_on)}
+
+
+def upgrade() -> None:
+    ${upgrades if upgrades else "pass"}
+
+
+def downgrade() -> None:
+    ${downgrades if downgrades else "pass"}

instant_python/templates/boilerplate/persistence/async/sqlalchemy_repository.py

@@ -0,0 +1,30 @@
+{% set template_domain_import = "shared.domain"|compute_base_path(template) %}
+{% set template_infra_import = "shared.infra"|compute_base_path(template) %}
+from typing import TypeVar
+
+from {{ source_name }}.{{ template_domain_import }}.value_objects.uuid import Uuid
+from {{ source_name }}.{{ template_infra_import }}.persistence.sqlalchemy.base import Base
+from sqlalchemy.ext.asyncio import AsyncEngine, AsyncSession, asynce_sessionmaker
+
+
+Entity = TypeVar("Entity")
+
+
+class SqlalchemyRepository[Model: Base]:
+	_model_class: type[Model]
+	_session_maker: asynce_sessionmaker[AssyncSession]
+
+	def __init__(self, engine: AsyncEngine, model_class: type[Model]) -> None:
+		self._session_maker = async_sessionmaker(bind=engine)
+		self._model_class = model_class
+
+	async def persist(self, entity: Entity) -> None:
+		async with self._session_maker() as session:
+			entity_model = self._model_class(**entity.to_dict())
+			session.add(entity_model)
+			await session.commit()
+
+	async def find(self, entity_id: Uuid) -> Entity:
+		async with self._session_maker() as session:
+			entity_model = await session.get(self._model_class, entity_id.value)
+			return entity_model.to_aggregate() if entity_model else None

instant_python/templates/boilerplate/persistence/base.py

@@ -0,0 +1,4 @@
+from sqlalchemy.orm import DeclarativeBase
+
+
+class Base(DeclarativeBase): ...

instant_python/templates/boilerplate/persistence/synchronous/session_maker.py

@@ -0,0 +1,22 @@
+{% set template_infra_import = "shared.infra"|compute_base_path(template) %}
+from sqlalchemy import create_engine, Engine
+from sqlalchemy.orm import sessionmaker, Session
+
+from {{ source_name }}.{{ template_infra_import }}.persistence.sqlalchemy.base import (
+	Base,
+)
+
+
+class SessionMaker:
+	_session_maker: sessionmaker[Session]
+	_engine: Engine
+
+	def __init__(self, url: str) -> None:
+		self._engine = create_engine(url)
+		self._session_maker = sessionmaker(bind=self._engine)
+
+	def get_session(self) -> Session:
+		return self._session_maker()
+
+	def create_tables(self) -> None:
+		Base.metadata.create_all(self._engine)

instant_python/templates/boilerplate/persistence/synchronous/sqlalchemy_repository.py

@@ -0,0 +1,35 @@
+{% set template_domain_import = "shared.domain"|compute_base_path(template) %}
+{% set template_infra_import = "shared.infra"|compute_base_path(template) %}
+from typing import Type, TypeVar
+
+from {{ source_name }}.{{ template_domain_import }}.value_objects.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,
+)
+
+Entity = TypeVar("Entity")
+
+
+class SqlAlchemyRepository[Model: Base]:
+	_model_class: Type[Model]
+	_session_maker: SessionMaker
+
+	def __init__(self, session_maker: SessionMaker, model_class: Type[Model]) -> None:
+		self._session_maker = session_maker
+		self._model_class = model_class
+
+	def persist(self, entity: Entity) -> None:
+		with self._session_maker.get_session() as session:
+			entity_model = self._model_class(**entity.to_dict())
+			session.add(entity_model)
+			session.commit()
+
+	def search_by_id(self, entity_id: Uuid) -> Entity | None:
+		with self._session_maker.get_session() as session:
+			entity_model = (
+				session.query(self._model_class)
+				.filter(self._model_class.id == entity_id.value)
+				.first()
+			)
+			return entity_model.to_aggregate() if entity_model else None

instant_python/templates/boilerplate/pyproject.toml

@@ -0,0 +1,29 @@
+[project]
+name = "{{ project_slug }}"
+version = "{{ version }}"
+description = "{{ description }}"
+authors = [{name = "{{ author }}", email = "{{ git_email }}"}]
+dependencies = [
+    {% if "async_sqlalchemy" in built_in_features %}
+    "sqlalchemy",
+    "asyncpg",
+    "psycopg2-binary",
+    {% endif %}
+    {% if "async_alembic" in built_in_features %}
+    "alembic",
+    {% endif %}
+    {% if "event_bus" in built_in_features %}
+    "pika",
+    {% endif %}
+    {% if "fastapi_application" in built_in_features %}
+    "fastapi[standard]",
+    {% endif %}
+]
+requires-python = "=={{ python_version }}.*"
+readme = "README.md"
+license = { file = "LICENSE" }
+
+{% if dependency_manager == "pdm" %}
+[tool.pdm]
+distribution = false
+{% endif %}

instant_python/templates/boilerplate/pytest.ini

@@ -0,0 +1,10 @@
+[pytest]
+markers =
+    unit: mark a test as a unit test
+    acceptance: mark a test as an acceptance test
+    integration: mark a test as an integration test
+testpaths =
+    tests
+asyncio_default_fixture_loop_scope =
+    function
+asyncio_mode = auto

instant_python/templates/boilerplate/random_generator.py

@@ -0,0 +1,9 @@
+from faker import Faker
+
+
+class RandomGenerator:
+	faker = Faker()
+
+	@classmethod
+	def uuid(cls) -> str:
+	    return cls.faker.uuid4()

instant_python/templates/boilerplate/scripts/add_dependency.sh

@@ -0,0 +1,37 @@
+#!/bin/bash
+
+read -p "Dependency to install: " dependency
+read -p "Do you want to install $dependency as a dev dependency? (y/n): " is_dev
+read -p "Do you want to install the $dependency inside a group? (y/n): " add_to_group
+
+{% if dependency_manager == "pdm" -%}
+dev_flag=""
+group_flag=""
+
+if [ "$is_dev" == "y" ]; then
+  flag="--dev"
+fi
+
+if [ "$add_to_group" == "y" ]; then
+  read -p "Group name: " group_name
+  flag="--group $group_name"
+fi
+
+pdm add $dev_flag $group_flag $dependency
+
+{%- elif dependency_manager == "uv" -%}
+flag=""
+
+if [ "$is_dev" == "y" ]; then
+  flag="--dev"
+fi
+
+if [ "$add_to_group" == "y" ]; then
+  read -p "Group name: " group_name
+  flag="--group $group_name"
+fi
+
+uv add $flag $dependency
+
+{%- endif %}
+