instant-python 0.0.1__py3-none-any.whl

instant_python/question_prompter/question/boolean_question.py

@@ -0,0 +1,13 @@
+import questionary
+
+from instant_python.question_prompter.question.question import Question
+
+
+class BooleanQuestion(Question[bool]):
+    def __init__(self, key: str, message: str, default: bool) -> None:
+        super().__init__(key, message)
+        self._default = default
+
+    def ask(self) -> dict[str, bool]:
+        answer = questionary.confirm(self._message, default=self._default).ask()
+        return {self._key: answer}

instant_python/question_prompter/question/choice_question.py

@@ -0,0 +1,18 @@
+import questionary
+
+from instant_python.question_prompter.question.question import Question
+
+
+class ChoiceQuestion(Question[str]):
+    def __init__(self, key: str, message: str, options: list[str] | None = None) -> None:
+        super().__init__(key, message)
+        self._default = options[0] if options else ""
+        self._options = options if options else []
+    
+    def ask(self) -> dict[str, str]:
+        answer = questionary.select(
+            self._message,
+            choices=self._options,
+            default=self._default,
+        ).ask()
+        return {self._key: answer}

instant_python/question_prompter/question/conditional_question.py

@@ -0,0 +1,25 @@
+from instant_python.question_prompter.question.question import Question
+
+
+class ConditionalQuestion:
+    def __init__(
+        self, base_question: Question, subquestions: list[Question], condition: str | bool
+    ) -> None:
+        self._base_question = base_question
+        self._subquestions = subquestions
+        self._condition = condition
+
+    def ask(self) -> dict[str, str]:
+        base_answer = self._base_question.ask()
+
+        if self._base_answer_does_not_satisfies_condition(base_answer):
+            return base_answer
+
+        answers = base_answer
+        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:
+        answer_value = next(iter(base_answer.values()))
+        return answer_value != self._condition

instant_python/question_prompter/question/dependencies_question.py

@@ -0,0 +1,43 @@
+from instant_python.question_prompter.question.boolean_question import BooleanQuestion
+from instant_python.question_prompter.question.free_text_question import (
+    FreeTextQuestion,
+)
+from instant_python.question_prompter.question.question import Question
+
+
+class DependenciesQuestion(Question[list[str]]):
+    def __init__(self, key: str, message: str) -> None:
+        super().__init__(key, message)
+
+    def ask(self) -> dict[str, list[str]]:
+        dependencies = []
+        while True:
+            user_wants_to_install_dependencies = BooleanQuestion(
+                key="keep_asking", message=self._message, default=False
+            ).ask()["keep_asking"]
+
+            if not user_wants_to_install_dependencies:
+                break
+
+            dependency = FreeTextQuestion(
+                key="dependency",
+                message="Enter the name of the dependency you want to install",
+            ).ask()["dependency"]
+
+            if not dependency:
+                print("Dependency name cannot be empty. Let's try again.")
+                continue
+
+            dependency_is_correct = BooleanQuestion(
+                key="dependency_is_correct",
+                message=f"Is '{dependency}' spelled correctly?",
+                default=True,
+            ).ask()["dependency_is_correct"]
+
+            if dependency_is_correct:
+                print(f"Dependency {dependency} will be installed.")
+                dependencies.append(dependency)
+            else:
+                print("Let's try again.")
+
+        return {self._key: dependencies}

instant_python/question_prompter/question/free_text_question.py

@@ -0,0 +1,13 @@
+import questionary
+
+from instant_python.question_prompter.question.question import Question
+
+
+class FreeTextQuestion(Question[str]):
+    def __init__(self, key: str, message: str, default: str | None = None) -> None:
+        super().__init__(key, message)
+        self._default = default if default else ""
+    
+    def ask(self) -> dict[str, str]:
+        answer = questionary.text(self._message, default=self._default).ask()
+        return {self._key: answer}

instant_python/question_prompter/question/multiple_choice_question.py

@@ -0,0 +1,13 @@
+import questionary
+
+from instant_python.question_prompter.question.question import Question
+
+
+class MultipleChoiceQuestion(Question[list[str]]):
+    def __init__(self, key: str, message: str, options: list[str]) -> None:
+        super().__init__(key, message)
+        self._options = options
+    
+    def ask(self) -> dict[str, list[str]]:
+        answer = questionary.checkbox(self._message, choices=self._options).ask()
+        return {self._key: answer}

instant_python/question_prompter/question/question.py

@@ -0,0 +1,15 @@
+from abc import ABC, abstractmethod
+
+
+class Question[T](ABC):
+    def __init__(self, key: str, message: str) -> None:
+        self._key = key
+        self._message = message
+
+    @abstractmethod
+    def ask(self) -> dict[str, T]:
+        raise NotImplementedError
+    
+    @property
+    def key(self) -> str:
+        return self._key

instant_python/question_prompter/question_wizard.py

@@ -0,0 +1,15 @@
+from instant_python.question_prompter.step.steps import Steps
+from instant_python.question_prompter.user_requirements import UserRequirements
+
+
+class QuestionWizard:
+    def __init__(self, steps: Steps) -> None:
+        self._steps = steps
+        self._answers = {}
+
+    def run(self) -> UserRequirements:
+        for step in self._steps:
+            answer = step.run(self._answers)
+            self._answers.update(answer)
+
+        return UserRequirements(**self._answers)

instant_python/question_prompter/step/dependencies_step.py

@@ -0,0 +1,20 @@
+from instant_python.question_prompter.question.dependencies_question import (
+    DependenciesQuestion,
+)
+from instant_python.question_prompter.step.steps import Step
+
+
+class DependenciesStep(Step):
+    def __init__(self) -> None:
+        self._questions = [
+            DependenciesQuestion(
+                key="dependencies",
+                message="Do you want to install any dependencies?",
+            )
+        ]
+
+    def run(self, answers_so_far: dict[str, str]) -> dict[str, str]:
+        for question in self._questions:
+            answers_so_far.update(question.ask())
+
+        return answers_so_far

instant_python/question_prompter/step/general_custom_template_project_step.py

@@ -0,0 +1,45 @@
+from instant_python.question_prompter.question.choice_question import ChoiceQuestion
+from instant_python.question_prompter.question.free_text_question import FreeTextQuestion
+from instant_python.question_prompter.step.steps import Step
+
+
+class GeneralCustomTemplateProjectStep(Step):
+	def __init__(self) -> None:
+		self._questions = [
+			FreeTextQuestion(
+				key="project_slug",
+				message="Enter the name of the project (CANNOT CONTAIN SPACES)",
+				default="python-project",
+			),
+			FreeTextQuestion(
+				key="description",
+				message="Enter the project description",
+				default="Python Project Description",
+			),
+			FreeTextQuestion(
+				key="version",
+				message="Enter the project initial version",
+				default="0.1.0",
+			),
+			FreeTextQuestion(key="author", message="Enter your name"),
+			ChoiceQuestion(
+				key="license",
+				message="Select a license",
+				options=["MIT", "Apache", "GPL"],
+			),
+			ChoiceQuestion(
+				key="python_version",
+				message="Enter the python version",
+				options=["3.13", "3.12", "3.11", "3.10"],
+			),
+			ChoiceQuestion(
+				key="dependency_manager",
+				message="Select a dependency manager",
+				options=["uv", "pdm"],
+			),
+		]
+
+	def run(self, answers_so_far: dict[str, str]) -> dict[str, str]:
+		for question in self._questions:
+			answers_so_far.update(question.ask())
+		return answers_so_far

instant_python/question_prompter/step/general_project_step.py

@@ -0,0 +1,50 @@
+from instant_python.question_prompter.question.choice_question import ChoiceQuestion
+from instant_python.question_prompter.question.free_text_question import FreeTextQuestion
+from instant_python.question_prompter.step.steps import Step
+
+
+class GeneralProjectStep(Step):
+    def __init__(self) -> None:
+        self._questions = [
+            FreeTextQuestion(
+                key="project_slug",
+                message="Enter the name of the project (CANNOT CONTAIN SPACES)",
+                default="python-project",
+            ),
+            FreeTextQuestion(
+                key="source_name",
+                message="Enter the name of the source folder",
+                default="src",
+            ),
+            FreeTextQuestion(
+                key="description",
+                message="Enter the project description",
+                default="Python Project Description",
+            ),
+            FreeTextQuestion(
+                key="version",
+                message="Enter the project initial version",
+                default="0.1.0",
+            ),
+            FreeTextQuestion(key="author", message="Enter your name"),
+            ChoiceQuestion(
+                key="license",
+                message="Select a license",
+                options=["MIT", "Apache", "GPL"],
+            ),
+            ChoiceQuestion(
+                key="python_version",
+                message="Enter the python version",
+                options=["3.13", "3.12", "3.11", "3.10"],
+            ),
+            ChoiceQuestion(
+                key="dependency_manager",
+                message="Select a dependency manager",
+                options=["uv", "pdm"],
+            ),
+        ]
+
+    def run(self, answers_so_far: dict[str, str]) -> dict[str, str]:
+        for question in self._questions:
+            answers_so_far.update(question.ask())
+        return answers_so_far

instant_python/question_prompter/step/git_step.py

@@ -0,0 +1,23 @@
+from instant_python.question_prompter.question.boolean_question import BooleanQuestion
+from instant_python.question_prompter.question.conditional_question import ConditionalQuestion
+from instant_python.question_prompter.question.free_text_question import FreeTextQuestion
+from instant_python.question_prompter.step.steps import Step
+
+
+class GitStep(Step):
+    def __init__(self) -> None:
+        self._questions = [
+            ConditionalQuestion(
+                base_question=BooleanQuestion(key="git", message="Do you want to initialize a git repository?", default=True),
+                subquestions=[
+                    FreeTextQuestion(key="git_user_name", message="Type your git user name"),
+                    FreeTextQuestion(key="git_email", message="Type your git email"),
+                ],
+                condition=True
+            )
+        ]
+
+    def run(self, answers_so_far: dict[str, str]) -> dict[str, str]:
+        for question in self._questions:
+            answers_so_far.update(question.ask())
+        return answers_so_far

instant_python/question_prompter/step/steps.py

@@ -0,0 +1,16 @@
+from abc import ABC, abstractmethod
+from collections.abc import Iterator
+
+
+class Step(ABC):
+    @abstractmethod
+    def run(self, answers_so_far: dict[str, str]) -> dict[str, str]:
+        raise NotImplementedError
+
+
+class Steps:
+    def __init__(self, *step: Step) -> None:
+        self._steps = list(step)
+
+    def __iter__(self) -> Iterator[Step]:
+        return iter(self._steps)

instant_python/question_prompter/step/template_step.py

@@ -0,0 +1,63 @@
+from instant_python.question_prompter.question.choice_question import ChoiceQuestion
+from instant_python.question_prompter.question.conditional_question import (
+    ConditionalQuestion,
+)
+from instant_python.question_prompter.question.free_text_question import (
+    FreeTextQuestion,
+)
+from instant_python.question_prompter.question.multiple_choice_question import (
+    MultipleChoiceQuestion,
+)
+from instant_python.question_prompter.step.steps import Step
+from instant_python.question_prompter.template_types import TemplateTypes
+
+
+class TemplateStep(Step):
+    def __init__(self) -> None:
+        self._questions = [
+            MultipleChoiceQuestion(
+                key="built_in_features",
+                message="Select the built-in features you want to include (fastapi_application option requires logger)",
+                options=[
+                    "value_objects",
+                    "github_actions",
+                    "makefile",
+                    "synchronous_sqlalchemy",
+                    "logger",
+                    "event_bus",
+                    "async_sqlalchemy",
+                    "async_alembic",
+                    "fastapi_application",
+                ],
+            ),
+            ConditionalQuestion(
+                base_question=ChoiceQuestion(
+                    key="template",
+                    message="Select a template",
+                    options=[
+                        "domain_driven_design",
+                        "clean_architecture",
+                        "standard_project",
+                    ],
+                ),
+                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=TemplateTypes.DDD,
+            ),
+        ]
+
+    def run(self, answers_so_far: dict[str, str]) -> dict[str, str]:
+        for question in self._questions:
+            answers_so_far.update(question.ask())
+
+        return answers_so_far

instant_python/question_prompter/template_types.py

@@ -0,0 +1,7 @@
+from enum import StrEnum
+
+
+class TemplateTypes(StrEnum):
+	DDD = "domain_driven_design"
+	CLEAN = "clean_architecture"
+	STANDARD = "standard_project"

instant_python/question_prompter/user_requirements.py

@@ -0,0 +1,39 @@
+from dataclasses import dataclass, asdict, field
+from datetime import datetime
+from pathlib import Path
+
+import yaml
+
+
+@dataclass
+class UserRequirements:
+    project_slug: str
+    license: str
+    version: str
+    description: str
+    author: str
+    python_version: str
+    dependency_manager: str
+    git: bool = field(default=False)
+    source_name: str = field(default_factory=str)
+    template: str = field(default_factory=str)
+    git_email: str = field(default_factory=str)
+    git_user_name: str = field(default_factory=str)
+    dependencies: list[str] = field(default_factory=list)
+    bounded_context: str = field(default_factory=str)
+    aggregate_name: str = field(default_factory=str)
+    built_in_features: list[str] = field(default_factory=list)
+    year: int = field(default=datetime.now().year)
+
+    def __post_init__(self) -> None:
+        self._file_path = "user_requirements.yml"
+
+    def to_dict(self) -> dict:
+        return asdict(self)
+
+    def save_in_memory(self) -> None:
+        with open(self._file_path, "w") as file:
+            yaml.dump(self.to_dict(), file)
+
+    def remove(self) -> None:
+        Path(self._file_path).unlink()

instant_python/templates/boilerplate/.gitignore

@@ -0,0 +1,164 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyPI configuration file
+.pypirc

instant_python/templates/boilerplate/.pre-commit-config.yml

@@ -0,0 +1,33 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: check-added-large-files
+      - id: check-ast
+      - id: check-case-conflict
+      - id: check-merge-conflict
+
+  - repo: local
+    hooks:
+      - id: type-check
+        name: check typing
+        entry: make check-typing
+        language: system
+      - id: lint
+        name: check for lint
+        entry: make lint
+        language: system
+      - id: format
+        name: check for code format
+        entry: make format
+        language: system
+      - id: unit-test
+        name: run all unit test
+        entry: make all-unit
+        language: system
+      - id: pre-push
+        name: run integration and acceptance test
+        entry: make pre-push
+        language: system
+        stages:
+          - pre-push

instant_python/templates/boilerplate/.python-version

@@ -0,0 +1 @@
+{{ python_version }}