instant-python 0.24.2__py3-none-any.whl → 0.26.0__py3-none-any.whl

instant_python/__init__.py

@@ -1 +1 @@
-__version__ = "0.24.2"
+__version__ = "0.26.0"

instant_python/config/application/config_generator.py

@@ -9,15 +9,13 @@ class ConfigGenerator:
         self._repository = repository
 
     def execute(self) -> None:
-        answers = self._ask_project_configuration_to_user()
-        config = self._create_configuration_based_on_answers(answers)
+        config = self._ask_project_configuration_to_user()
+        if not config:
+            return
         self._save_configuration(config)
 
-    def _create_configuration_based_on_answers(self, answers: dict) -> ConfigSchema:
-        return ConfigSchema.from_primitives(answers)
-
     def _save_configuration(self, config: ConfigSchema) -> None:
         self._repository.write(config)
 
-    def _ask_project_configuration_to_user(self) -> dict:
+    def _ask_project_configuration_to_user(self) -> ConfigSchema | None:
         return self._question_wizard.run()

instant_python/config/delivery/cli.py

@@ -1,6 +1,7 @@
 import typer
 
 from instant_python.config.application.config_generator import ConfigGenerator
+from instant_python.config.infra.question_wizard.console_answers_review_formatter import ConsoleAnswersReviewFormatter
 from instant_python.config.infra.question_wizard.questionary_console_wizard import QuestionaryConsoleWizard
 from instant_python.config.infra.question_wizard.step.questionary import Questionary
 from instant_python.shared.infra.persistence.yaml_config_repository import YamlConfigRepository
@@ -12,7 +13,7 @@ app = typer.Typer()
 def generate_ipy_configuration_file() -> None:
     config_generator = ConfigGenerator(
         question_wizard=QuestionaryConsoleWizard(
-            questionary=Questionary(),
+            questionary=Questionary(), review_formatter=ConsoleAnswersReviewFormatter()
         ),
         repository=YamlConfigRepository(),
     )

instant_python/config/domain/answers_review_formatter.py

@@ -0,0 +1,7 @@
+from abc import ABC, abstractmethod
+
+
+class AnswersReviewFormatter(ABC):
+    @abstractmethod
+    def print_answers(self, answers: dict) -> None:
+        raise NotImplementedError

instant_python/config/domain/question_wizard.py

@@ -1,7 +1,9 @@
 from abc import ABC, abstractmethod
 
+from instant_python.shared.domain.config_schema import ConfigSchema
+
 
 class QuestionWizard(ABC):
     @abstractmethod
-    def run(self) -> dict:
+    def run(self) -> ConfigSchema | None:
         raise NotImplementedError

instant_python/config/infra/question_wizard/console_answers_review_formatter.py

@@ -0,0 +1,34 @@
+from typing import ClassVar
+
+from instant_python.config.domain.answers_review_formatter import AnswersReviewFormatter
+
+
+class ConsoleAnswersReviewFormatter(AnswersReviewFormatter):
+    _TITLE = "Review Configuration"
+    _SECTION_TITLES: ClassVar[dict[str, str]] = {
+        "general": "General",
+        "template": "Template",
+        "git": "Git",
+        "dependencies": "Dependencies",
+    }
+
+    def print_answers(self, answers: dict) -> None:
+        summary = [self._TITLE]
+        for section_key, section_content in answers.items():
+            section_title = self._SECTION_TITLES[section_key]
+            summary.append(section_title)
+            if not section_content:
+                summary.append("  None")
+                continue
+            if isinstance(section_content, list):
+                for dependency in section_content:
+                    env_content = "(prod)"
+                    if dependency["is_dev"] is True:
+                        env_content = f"(dev, group: {dependency['group']})" if dependency["group"] != "" else "(dev)"
+                    summary.append(f"  {dependency['name']}=={dependency['version']} {env_content}")
+                continue
+            for field_title, field_content in section_content.items():
+                if isinstance(field_content, list):
+                    field_content = "None" if not field_content else ", ".join(field_content)
+                summary.append(f"  {field_title.title().replace('_', ' ')}: {field_content}")
+        print("\n".join(summary))

instant_python/config/infra/question_wizard/questionary_console_wizard.py

@@ -1,3 +1,4 @@
+from instant_python.config.domain.answers_review_formatter import AnswersReviewFormatter
 from instant_python.config.domain.question_wizard import QuestionWizard
 from instant_python.config.infra.question_wizard.step.dependencies_step import DependenciesStep
 from instant_python.config.infra.question_wizard.step.general_step import GeneralStep
@@ -5,25 +6,41 @@ from instant_python.config.infra.question_wizard.step.git_step import GitStep
 from instant_python.config.infra.question_wizard.step.questionary import Questionary
 from instant_python.config.infra.question_wizard.step.steps import Steps
 from instant_python.config.infra.question_wizard.step.template_step import TemplateStep
+from instant_python.shared.domain.config_schema import ConfigSchema
 
 
 class QuestionaryConsoleWizard(QuestionWizard):
-    def __init__(self, questionary: Questionary) -> None:
+    def __init__(self, questionary: Questionary, review_formatter: AnswersReviewFormatter) -> None:
         self._steps = Steps(
             GeneralStep(questionary=questionary),
             TemplateStep(questionary=questionary),
             GitStep(questionary=questionary),
             DependenciesStep(questionary=questionary),
         )
+        self._review_formatter = review_formatter
+        self._questionary = questionary
         self._answers = {}
 
-    def run(self) -> dict:
+    def run(self) -> ConfigSchema | None:
         for position, step in enumerate(self._steps, start=1):
             self._show_section_heading(position, step.title)
             answer = step.run()
             self._answers.update(answer)
 
-        return self._answers
+        config = ConfigSchema.from_primitives(self._answers)
+        self._show_answers_summary(config)
+        if self._user_wants_to_discard_config():
+            print("Configuration has been discarded. No 'ipy.yml' will be created.")
+            return None
+        return config
 
     def _show_section_heading(self, position: int, section_title: str) -> None:
         print(f"[{position}/{len(self._steps)}] {section_title}")
+
+    def _show_answers_summary(self, config: ConfigSchema) -> None:
+        self._review_formatter.print_answers(dict(**config.to_primitives()))
+
+    def _user_wants_to_discard_config(self) -> bool:
+        return not self._questionary.boolean_question(
+            message="Do you want to save this project configuration?", default=True
+        )

instant_python/initialize/infra/renderer/jinja_environment.py

@@ -1,4 +1,5 @@
 from collections.abc import Callable
+from datetime import datetime, timezone
 from typing import Any, ClassVar
 
 from jinja2 import ChoiceLoader, Environment, FileSystemLoader, PackageLoader
@@ -32,6 +33,7 @@ class JinjaEnvironment:
         self.add_filter("compute_base_path", _compute_base_path)
         self.add_filter("has_dependency", _has_dependency)
         self.add_filter("resolve_import_path", _resolve_import_path)
+        self._env.globals["current_year"] = datetime.now(tz=timezone.utc).year
 
     def render_template(self, name: str, context: dict[str, Any] | None = None) -> str:
         template = self._env.get_template(name)

instant_python/shared/domain/config_schema.py

@@ -21,6 +21,9 @@ _TEMPLATE = "template"
 _GIT = "git"
 _REQUIRED_CONFIG_KEYS = [_GENERAL, _DEPENDENCIES, _TEMPLATE, _GIT]
 
+# Dropped rather than rejected so config files saved by older versions still load.
+_LEGACY_GENERAL_KEYS = {"year"}
+
 
 @dataclass
 class ConfigSchema:
@@ -36,8 +39,9 @@ class ConfigSchema:
     def from_primitives(cls, content: dict[str, dict | list], custom_config_path: Path | None = None) -> "ConfigSchema":
         cls._ensure_config_is_not_empty(content)
         cls._ensure_all_required_sections_are_present(content)
+        general_content = {k: v for k, v in content[_GENERAL].items() if k not in _LEGACY_GENERAL_KEYS}
         return cls(
-            general=GeneralConfig(**content[_GENERAL]),
+            general=GeneralConfig(**general_content),
             dependencies=[DependencyConfig(**dep) for dep in content[_DEPENDENCIES]] if content[_DEPENDENCIES] else [],
             template=TemplateConfig(**content[_TEMPLATE]),
             git=GitConfig(**content[_GIT]),

instant_python/shared/domain/general_config.py

@@ -1,6 +1,5 @@
 import re
-from dataclasses import asdict, dataclass, field
-from datetime import datetime, timezone
+from dataclasses import asdict, dataclass
 
 from instant_python.shared.application_error import ApplicationError
 from instant_python.shared.supported_licenses import SupportedLicenses
@@ -18,17 +17,16 @@ class GeneralConfig:
     license: str
     python_version: str
     dependency_manager: str
-    year: int = field(default=datetime.now(tz=timezone.utc).year)
 
     def __post_init__(self) -> None:
         self.version = str(self.version)
         self.python_version = str(self.python_version)
-        self._remove_invalid_characters_from_slug_and_normalyze_hyphens()
+        self._remove_invalid_characters_from_slug_and_normalize_hyphens()
         self._ensure_license_is_supported()
         self._ensure_python_version_is_supported()
         self._ensure_dependency_manager_is_supported()
 
-    def _remove_invalid_characters_from_slug_and_normalyze_hyphens(self) -> None:
+    def _remove_invalid_characters_from_slug_and_normalize_hyphens(self) -> None:
         normalized_slug = re.sub(r"[^a-z0-9]+", "-", self.slug.lower()).strip("-")
         if not normalized_slug:
             raise InvalidSlugValue(self.slug)

instant_python/templates/boilerplate/LICENSE

@@ -187,7 +187,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright [{{ general.year }}] [{{ general.author }}]
+   Copyright [{{ current_year }}] [{{ general.author }}]
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.
@@ -198,7 +198,7 @@
 {% elif general.license == 'MIT' %}
 MIT License
 
-Copyright (c) {{ general.year }} {{ general.author }}
+Copyright (c) {{ current_year }} {{ general.author }}
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -873,7 +873,7 @@ Also add information on how to contact you by electronic and paper mail.
   If the program does terminal interaction, make it output a short
 notice like this when it starts in an interactive mode:
 
-    <program>  Copyright (C) <{{ general.year }}>  <{{ general.author }}>
+    <program>  Copyright (C) <{{ current_year }}>  <{{ general.author }}>
     This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
     This is free software, and you are welcome to redistribute it
     under certain conditions; type `show c' for details.

{instant_python-0.24.2.dist-info → instant_python-0.26.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
-Metadata-Version: 2.4
+Metadata-Version: 2.5
 Name: instant-python
-Version: 0.24.2
+Version: 0.26.0
 Summary: Instant boilerplate generation for Python projects
 Project-URL: documentation, https://dimanu-py.github.io/instant-python/
 Project-URL: repository, https://github.com/dimanu-py/instant-python/
@@ -264,6 +264,20 @@ commands like `ng new` or `create-react-app`, but for Python projects.
 
 </td></tr></table></div>
 
+## 🚀 Quick Start
+
+Once [installed](https://dimanu-py.github.io/instant-python/getting_started/installation/), generating a project takes two commands:
+
+```bash
+ipy config   # answer a few questions through an interactive wizard to create your ipy.yml configuration file
+ipy init     # generate the project from that configuration file
+```
+
+- `ipy config` asks you about your project (name, Python version, project manager, template, dependencies, and more) and writes an `ipy.yml` configuration file in the current directory.
+- `ipy init` reads that `ipy.yml` file and generates your new project.
+
+See the [First Steps](https://dimanu-py.github.io/instant-python/getting_started/first_steps/) guide for a full walkthrough.
+
 ## ✨ NEW ✨ Create Fully Customized Projects
 
 Take full control of your project generation! With **custom templates**, you can:

{instant_python-0.24.2.dist-info → instant_python-0.26.0.dist-info}/RECORD

@@ -1,17 +1,19 @@
-instant_python/__init__.py,sha256=UBF3OYTcBAovta3ux5ybxb0MZYAGpGO79WH_ax2NGeI,23
+instant_python/__init__.py,sha256=S1dNBNSmHJkAHkq1vL1Yg-dFpQk0fri_CstNlL1u5qw,23
 instant_python/cli/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 instant_python/cli/cli.py,sha256=JJBJ48YFf7mwjyGjZLSZBzBVDF6syEt5B2n-hkQR1lg,1618
 instant_python/cli/instant_python_typer.py,sha256=qChUAmoTT49FIHc94MJhzAXvxztXJwaCPUpD-4ml5ZU,1250
 instant_python/config/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 instant_python/config/application/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-instant_python/config/application/config_generator.py,sha256=idsAvVjcOuk4_6DcEiziUHIMt9-hKKJ7c3JEQq5ITwM,971
+instant_python/config/application/config_generator.py,sha256=2J691YoAa2VHZ5D9VLsIP0Y3ImRm3WbQin3zPb43uv4,818
 instant_python/config/delivery/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-instant_python/config/delivery/cli.py,sha256=XD8nOCQjDhBzyyq3H9N8aS14NmDEIYXH7Y6AQpdsu9Y,753
+instant_python/config/delivery/cli.py,sha256=JWKDK_wzZiVmMEEq--7FQ8532_fsKatdh279h853qW8,921
 instant_python/config/domain/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-instant_python/config/domain/question_wizard.py,sha256=mSqESa4xC6F2OEJZ338dokXZ34Y22aBMAGmARhBQSnY,146
+instant_python/config/domain/answers_review_formatter.py,sha256=b2K2abu9mzVhEXji_foPGWD9fu0kMvKLSyAQA9WOIeQ,179
+instant_python/config/domain/question_wizard.py,sha256=Dwp6_JngrPYNY3nBZlyY6v1ccsTa5EwFEVjTgYaqy48,230
 instant_python/config/infra/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 instant_python/config/infra/question_wizard/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-instant_python/config/infra/question_wizard/questionary_console_wizard.py,sha256=AdDZI_2ajfTzJF4k35Xr9NA3tIi7ub7DKMtj9EJMqD8,1356
+instant_python/config/infra/question_wizard/console_answers_review_formatter.py,sha256=Hg16vPloyDqsLbVvxVvrR3Z7O4L7ZFQ4KjyPb0o_rg4,1536
+instant_python/config/infra/question_wizard/questionary_console_wizard.py,sha256=AeuHWXDZ7QBuIDXy_67a9lEzrZPo0kvYkPqc-ohpmnU,2263
 instant_python/config/infra/question_wizard/step/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 instant_python/config/infra/question_wizard/step/dependencies_step.py,sha256=1744qPP8jEpHHp1irZu6SuN7qwtJtUDKslcxwGzKva8,2661
 instant_python/config/infra/question_wizard/step/general_step.py,sha256=RJmd-0wCB78UqSAPVgqJEgQTAGOapQLaeg8qomPVogw,3076
@@ -41,7 +43,7 @@ instant_python/initialize/infra/env_manager/uv_env_manager.py,sha256=kYYDO7spQeD
 instant_python/initialize/infra/formatter/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 instant_python/initialize/infra/formatter/ruff_project_formatter.py,sha256=AE3DYoDC-NZse3Mv2MW5VqsUigiIMscCCETPJ_Rr_Io,398
 instant_python/initialize/infra/renderer/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-instant_python/initialize/infra/renderer/jinja_environment.py,sha256=lfH5kaUOans2uJRKSYaJE59iiRWE1tdNFc6tbPF5j2c,2863
+instant_python/initialize/infra/renderer/jinja_environment.py,sha256=OHOYkXNh_84w67rTjW6hSNTPK-PbsnVBbk0O83HLZA0,2982
 instant_python/initialize/infra/renderer/jinja_project_renderer.py,sha256=GeHGZYfLKj-cxevKk3B87iW3OmXrWmUWw7cnaDO9ABI,2831
 instant_python/initialize/infra/version_control/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 instant_python/initialize/infra/version_control/git_configurer.py,sha256=W4WzoHbZ3RtAjmpRzeBGsreHxBCX_vtYSB2GpNF4Tcg,1232
@@ -71,9 +73,9 @@ instant_python/shared/supported_python_versions.py,sha256=KTtD8Cu7zJiLW_9C6quWCR
 instant_python/shared/supported_templates.py,sha256=Sl6pFsyrb2F8hUsy-_ZP4RIX0Kr_Q_zw9a0shevCp8M,304
 instant_python/shared/domain/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 instant_python/shared/domain/config_repository.py,sha256=8iHVflpRMFA_qpSPux8v9b3Yulp73oJHdH2ZiEOqhwM,498
-instant_python/shared/domain/config_schema.py,sha256=-Pt-9QS9lJSGp70cfG86-w48DYzr7KgRJG2ZeofUXIc,4277
+instant_python/shared/domain/config_schema.py,sha256=12uITyxvTsy7_utOTd0mmMTt5Zz6ty9s-qKBijGk9Q0,4495
 instant_python/shared/domain/dependency_config.py,sha256=SH5CubFFv6NHAc75Jy16MNbtebdP1jZRmZ9OOm8bD44,1412
-instant_python/shared/domain/general_config.py,sha256=gGhZMVqnRrJMAGXLh0OnaSbHH8uh51FiVKk8PQl0PEc,3214
+instant_python/shared/domain/general_config.py,sha256=HE8vq6LpOb8BN9mBek5thqHjuiMrvx-SKJOkEy1Vauo,3101
 instant_python/shared/domain/git_config.py,sha256=_5FKISV1oaZM9MHHKYrqQJrY2BtS0dMR3XagKws0or4,1081
 instant_python/shared/domain/template_config.py,sha256=doylcLSPYrBiBbQOQjd5S6uZow9lmpEQ58ADUkK0fDw,3299
 instant_python/shared/infra/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -83,7 +85,7 @@ instant_python/templates/boilerplate/.gitignore,sha256=ViomTBHDFOJHHeRAL6UugoaNy
 instant_python/templates/boilerplate/.pre-commit-config.yaml,sha256=BiF6JdygrPbXhJjUc_eJm-iSL8RkGQE20RfQakVynsc,1724
 instant_python/templates/boilerplate/.python-version,sha256=7b_kfEdqh7QsWx4IDCSWhbwielSfsmsAEZPM3kjSuBA,28
 instant_python/templates/boilerplate/CITATION.cff,sha256=m1fHRwEfq7HvL9uMJ8H1sPk91teJYldVlD3M2OiyFAE,401
-instant_python/templates/boilerplate/LICENSE,sha256=wzw1JFV1qGbnRMfokpku4CO4ZKvtreFsyIksljC7hLI,47428
+instant_python/templates/boilerplate/LICENSE,sha256=VLwfNpljs2YkwgDmcP5qs1fsr-Ik5TEJlwpQKhLUJ84,47428
 instant_python/templates/boilerplate/README.md,sha256=qlaO6Tnd8k0A_ccRNVI8yt5Vn1dQP6AwxW_WH80P8Is,238
 instant_python/templates/boilerplate/SECURITY.md,sha256=l2T8a7mcV3PUs1vloUDqFXlRXKseInsT_nR71wlLvGo,2024
 instant_python/templates/boilerplate/mkdocs.yml,sha256=WOp2M_SWQAoyEMhTCZhg7loi4MuuqkFkXAb6GicoEjM,1727
@@ -240,8 +242,8 @@ instant_python/templates/project_structure/standard_project/test.yml,sha256=k5dE
 instant_python/templates/project_structure/standard_project/layers/source_features.yml,sha256=iVFOa5juIaiZObznHuSFoBCQXWwlDdX3UcO9GfBMAH4,781
 instant_python/templates/project_structure/standard_project/layers/test_event_bus.yml,sha256=81fC2jIvK-0bLOIDSRi2Uab3dXigfjiEk6xT8PbzP0w,165
 instant_python/templates/project_structure/standard_project/layers/test_features.yml,sha256=MfyuXbdF2K8zCXdDYRYTqDnWQ0_kkE1XeEfJVio_ALs,302
-instant_python-0.24.2.dist-info/METADATA,sha256=NMdxXXd_5K10b4bG0WwC-adpmCwoQufO63DlCJl_Flk,19911
-instant_python-0.24.2.dist-info/WHEEL,sha256=lCkmxWfQsSc9CfIClYeavTdQeEX2toPqufh9gI35EQA,87
-instant_python-0.24.2.dist-info/entry_points.txt,sha256=M8YUHQaTszBM3np_x9j7wmc1ngrmpfrd4ajBv2EzQuk,51
-instant_python-0.24.2.dist-info/licenses/LICENSE,sha256=kf7wA-1IsqXkzXjlsG95sdQJtsqUON_lNXombfPlklo,11353
-instant_python-0.24.2.dist-info/RECORD,,
+instant_python-0.26.0.dist-info/METADATA,sha256=npnFI6FByLQ8g8yaY8nzkCh84oIXX9D3e-ghhxeY7Lk,20638
+instant_python-0.26.0.dist-info/WHEEL,sha256=zOwg4jB6zX2kU910N-cMawjivD6tO8NEWvE12je1bVk,87
+instant_python-0.26.0.dist-info/entry_points.txt,sha256=M8YUHQaTszBM3np_x9j7wmc1ngrmpfrd4ajBv2EzQuk,51
+instant_python-0.26.0.dist-info/licenses/LICENSE,sha256=kf7wA-1IsqXkzXjlsG95sdQJtsqUON_lNXombfPlklo,11353
+instant_python-0.26.0.dist-info/RECORD,,

{instant_python-0.24.2.dist-info → instant_python-0.26.0.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: hatchling 1.31.0
+Generator: hatchling 1.32.0
 Root-Is-Purelib: true
 Tag: py3-none-any