instant-python 0.6.2__tar.gz → 0.8.0__tar.gz

{instant_python-0.6.2 → instant_python-0.8.0}/CHANGELOG.md

@@ -1,3 +1,28 @@
+## 0.8.0 (2025-07-01)
+
+### ✨ Features
+
+- **dependency-manager**: get dependency manager installation command based on system os
+- **dependency-manager**: set different commands for dependency executable based on system os
+- **dependency-manager**: add os information in dependency manager to be able to modify installation depending on user os
+
+### ♻️ Code Refactoring
+
+- **dependency-manager**: add message for the user to notify uv should be added to the path when installing it on windows
+- **dependency-manager**: notify the user when all dependencies have been installed
+- **dependency-manager**: extract method to set executable path setting based on system os
+
+## 0.7.0 (2025-06-30)
+
+### ✨ Features
+
+- **commands**: call project formatter in 'init' command once the file system has been generated
+- **formatter**: add project formatter to be able to format included code in the project
+
+### 🐛 Bug Fixes
+
+- **templates**: include DomainError template when using fastapi application built in feature
+
 ## 0.6.2 (2025-06-30)
 
 ### 🐛 Bug Fixes

{instant_python-0.6.2 → instant_python-0.8.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: instant-python
-Version: 0.6.2
+Version: 0.8.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/
@@ -210,6 +210,7 @@ License-File: LICENSE
 Classifier: Environment :: Console
 Classifier: Intended Audience :: Developers
 Classifier: Operating System :: MacOS
+Classifier: Operating System :: Microsoft :: Windows
 Classifier: Operating System :: POSIX :: Linux
 Classifier: Operating System :: Unix
 Classifier: Topic :: Software Development :: Code Generators

{instant_python-0.6.2 → instant_python-0.8.0}/instant_python/commands/init.py

@@ -2,6 +2,7 @@ import typer
 
 from instant_python.configuration.parser.parser import Parser
 from instant_python.dependency_manager.dependency_manager_factory import DependencyManagerFactory
+from instant_python.formatter.project_formatter import ProjectFormatter
 from instant_python.git.git_configurer import GitConfigurer
 from instant_python.project_creator.file_system import FileSystem
 from instant_python.render.custom_project_renderer import CustomProjectRenderer
@@ -44,6 +45,9 @@ def create_new_project(
         dependencies=configuration.dependencies,
     )
 
+    formatter = ProjectFormatter(project_directory=configuration.project_folder_name)
+    formatter.format()
+
     git_configurer = GitConfigurer(project_directory=configuration.project_folder_name)
     git_configurer.setup_repository(configuration.git)
     configuration.save_on_project_folder()

{instant_python-0.6.2 → instant_python-0.8.0}/instant_python/dependency_manager/dependency_manager.py

@@ -1,5 +1,6 @@
 import subprocess
 from abc import ABC, abstractmethod
+import sys
 
 from instant_python.configuration.dependency.dependency_configuration import DependencyConfiguration
 
@@ -7,6 +8,7 @@ from instant_python.configuration.dependency.dependency_configuration import Dep
 class DependencyManager(ABC):
     def __init__(self, project_directory: str) -> None:
         self._project_directory = project_directory
+        self._system_os = sys.platform
 
     @abstractmethod
     def setup_environment(self, python_version: str, dependencies: list[DependencyConfiguration]) -> None:

{instant_python-0.6.2 → instant_python-0.8.0}/instant_python/dependency_manager/pdm_dependency_manager.py

@@ -1,3 +1,4 @@
+from pathlib import Path
 import subprocess
 
 from instant_python.configuration.dependency.dependency_configuration import DependencyConfiguration
@@ -8,7 +9,7 @@ from instant_python.dependency_manager.command_execution_error import CommandExe
 class PdmDependencyManager(DependencyManager):
     def __init__(self, project_directory: str) -> None:
         super().__init__(project_directory)
-        self._pdm = "~/.local/bin/pdm"
+        self._pdm = self._set_pdm_executable_based_on_os()
 
     def setup_environment(self, python_version: str, dependencies: list[DependencyConfiguration]) -> None:
         try:
@@ -20,9 +21,21 @@ class PdmDependencyManager(DependencyManager):
 
     def _install(self) -> None:
         print(">>> Installing pdm...")
-        self._run_command(command="curl -sSL https://pdm-project.org/install-pdm.py | python3 -")
+        self._run_command(command=self._get_installation_command_based_on_os())
         print(">>> pdm installed successfully")
 
+    def _set_pdm_executable_based_on_os(self):
+        return (
+            f"{str(Path.home() / 'AppData' / 'Roaming' / 'Python' / 'Scripts' / 'pdm.exe')}"
+            if self._system_os.startswith("win")
+            else "~/.local/bin/pdm"
+        )
+
+    def _get_installation_command_based_on_os(self) -> str:
+        if self._system_os.startswith("win"):
+            return 'powershell -ExecutionPolicy ByPass -c "irm https://pdm-project.org/install-pdm.py | py -"'
+        return "curl -sSL https://pdm-project.org/install-pdm.py | python3 -"
+
     def _install_python(self, version: str) -> None:
         print(f">>> Installing Python {version}...")
         self._run_command(command=f"{self._pdm} python install {version}")
@@ -34,6 +47,7 @@ class PdmDependencyManager(DependencyManager):
         for dependency in dependencies:
             command = self._build_dependency_install_command(dependency)
             self._run_command(command)
+        print(">>> Dependencies installed successfully")
 
     def _build_dependency_install_command(self, dependency: DependencyConfiguration) -> str:
         command = [f"{self._pdm} add"]

{instant_python-0.6.2 → instant_python-0.8.0}/instant_python/dependency_manager/uv_dependency_manager.py

@@ -1,3 +1,4 @@
+from pathlib import Path
 import subprocess
 
 from instant_python.configuration.dependency.dependency_configuration import DependencyConfiguration
@@ -8,7 +9,7 @@ from instant_python.dependency_manager.command_execution_error import CommandExe
 class UvDependencyManager(DependencyManager):
     def __init__(self, project_directory: str) -> None:
         super().__init__(project_directory)
-        self._uv = "~/.local/bin/uv"
+        self._uv = self._set_uv_executable_based_on_os()
 
     def setup_environment(self, python_version: str, dependencies: list[DependencyConfiguration]) -> None:
         try:
@@ -20,8 +21,29 @@ class UvDependencyManager(DependencyManager):
 
     def _install(self) -> None:
         print(">>> Installing uv...")
-        self._run_command(command="curl -LsSf https://astral.sh/uv/install.sh | sh")
+        self._run_command(command=self._get_installation_command_based_on_os())
         print(">>> uv installed successfully")
+        if self._system_os.startswith("win"):
+            print(
+                ">>> Remember to add uv to your PATH environment variable. You can do this:\n"
+                "    1. Running the following command if you use cmd:\n"
+                "       set Path=%Path%;%USERPROFILE%\\.local\\bin\n"
+                "    2. Running the following command if you use PowerShell:\n"
+                "       $env:Path = '$env:USERPROFILE\\.local\\bin;$env:Path'\n"
+                "    3. Restarting your shell."
+            )
+
+    def _get_installation_command_based_on_os(self) -> str:
+        if self._system_os.startswith("win"):
+            return 'powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"'
+        return "curl -LsSf https://astral.sh/uv/install.sh | sh"
+
+    def _set_uv_executable_based_on_os(self):
+        return (
+            f"{str(Path.home() / '.local' / 'bin' / 'uv.exe')}"
+            if self._system_os.startswith("win")
+            else "~/.local/bin/uv"
+        )
 
     def _install_python(self, version: str) -> None:
         print(f">>> Installing Python {version}...")
@@ -34,6 +56,7 @@ class UvDependencyManager(DependencyManager):
         for dependency in dependencies:
             command = self._build_dependency_install_command(dependency)
             self._run_command(command)
+        print(">>> Dependencies installed successfully")
 
     def _build_dependency_install_command(self, dependency: DependencyConfiguration) -> str:
         command = [f"{self._uv} add"]

instant_python-0.8.0/instant_python/formatter/project_formatter.py

@@ -0,0 +1,19 @@
+import subprocess
+
+
+class ProjectFormatter:
+    def __init__(self, project_directory: str) -> None:
+        self._project_directory = project_directory
+
+    def format(self) -> None:
+        self._run_command(command="uvx ruff format")
+
+    def _run_command(self, command: str) -> None:
+        subprocess.run(
+            command,
+            shell=True,
+            check=True,
+            cwd=self._project_directory,
+            stdout=subprocess.DEVNULL,
+            stderr=subprocess.PIPE,
+        )

{instant_python-0.6.2 → instant_python-0.8.0}/instant_python/templates/project_structure/clean_architecture/source.yml.j2

@@ -13,7 +13,7 @@
     - name: domain
       type: directory
       python: True
-      {% if ["value_objects", "event_bus"] | is_in(template.built_in_features) %}
+      {% if ["value_objects", "event_bus", "fastapi_application"] | is_in(template.built_in_features) %}
       children:
         {% if "value_objects" in template.built_in_features %}
         {{ macros.include_and_indent("project_structure/value_objects.yml.j2", 8) }}
@@ -21,6 +21,9 @@
         {% if "event_bus" in template.built_in_features %}
         {{ macros.include_and_indent("project_structure/event_bus_domain.yml.j2", 8) }}
         {% endif %}
+        {% if "fastapi_application" in template.built_in_features %}
+        {{ macros.include_and_indent("project_structure/fastapi_domain.yml.j2", 8) }}
+        {% endif %}
       {% endif %}
     - name: application
       type: directory

{instant_python-0.6.2 → instant_python-0.8.0}/instant_python/templates/project_structure/domain_driven_design/source.yml.j2

@@ -13,9 +13,9 @@
     - name: shared
       type: directory
       python: True
-      {% if ["value_objects", "synchronous_sqlalchemy", "event_bus", "async_alembic"] | is_in(template.built_in_features) %}
+      {% if ["value_objects", "synchronous_sqlalchemy", "event_bus", "async_alembic", "fastapi_application"] | is_in(template.built_in_features) %}
       children:
-      {% if ["value_objects", "event_bus"] | is_in(template.built_in_features) %}
+      {% if ["value_objects", "event_bus", "fastapi_application"] | is_in(template.built_in_features) %}
         - name: domain
           type: directory
           python: True
@@ -26,6 +26,9 @@
             {% if "event_bus" in template.built_in_features %}
             {{ macros.include_and_indent("project_structure/event_bus_domain.yml.j2", 12) }}
             {% endif %}
+            {% if "fastapi_application" in template.built_in_features %}
+            {{ macros.include_and_indent("project_structure/fastapi_domain.yml.j2", 12) }}
+            {% endif %}
       {% endif %}
       {% if ["synchronous_sqlalchemy", "event_bus", "logger", "async_sqlalchemy", "async_alembic", "fastapi_application"] | is_in(template.built_in_features) %}
         - name: infra

instant_python-0.8.0/instant_python/templates/project_structure/fastapi_domain.yml.j2

@@ -0,0 +1,7 @@
+- name: exceptions
+  type: directory
+  python: True
+  children:
+    - name: exceptions/domain_error
+      type: boilerplate_file
+      extension: .py

{instant_python-0.6.2 → instant_python-0.8.0}/instant_python/templates/project_structure/standard_project/source.yml.j2

@@ -26,5 +26,6 @@
     {% if "fastapi_application" in template.built_in_features %}
     {{ macros.include_and_indent("project_structure/fastapi_app.yml.j2", 4) }}
     {{ macros.include_and_indent("project_structure/fastapi_infra.yml.j2", 4) }}
+    {{ macros.include_and_indent("project_structure/fastapi_domain.yml.j2", 4) }}
     {% endif %}
   {% endif %}

{instant_python-0.6.2 → instant_python-0.8.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "instant-python"
-version = "0.6.2"
+version = "0.8.0"
 description = "Instant boilerplate generation for Python projects"
 readme = "README.md"
 license = { file = "LICENSE" }
@@ -26,7 +26,8 @@ classifiers = [
     "Intended Audience :: Developers",
     "Operating System :: MacOS",
     "Operating System :: POSIX :: Linux",
-    "Operating System :: Unix"
+    "Operating System :: Unix",
+    "Operating System :: Microsoft :: Windows",
 ]
 
 include = [
@@ -41,7 +42,7 @@ repository = "https://github.com/dimanu-py/instant-python/"
 ipy = "instant_python.cli:app"
 
 [tool.ruff]
-exclude = ["instant_python/templates/**", "instant_python/new_templates/**"]
+exclude = ["instant_python/templates/**"]
 line-length = 120
 
 [tools.pytest.ini_options]

instant_python-0.8.0/test/formatter/mock_project_formatter.py

@@ -0,0 +1,15 @@
+from expects import expect, contain
+
+from instant_python.formatter.project_formatter import ProjectFormatter
+
+
+class MockProjectFormatter(ProjectFormatter):
+    def __init__(self, project_directory: str) -> None:
+        super().__init__(project_directory)
+        self._commands: list[str] = []
+
+    def _run_command(self, command: str) -> None:
+        self._commands.append(command)
+
+    def expect_to_have_been_called_with(self, command: str) -> None:
+        expect(self._commands).to(contain(command))

instant_python-0.8.0/test/formatter/test_project_formatter.py

@@ -0,0 +1,13 @@
+import os
+
+from test.formatter.mock_project_formatter import MockProjectFormatter
+
+
+class TestProjectFormatter:
+    def setup_method(self) -> None:
+        self._formatter = MockProjectFormatter(project_directory=os.getcwd())
+
+    def test_should_format_project_files(self) -> None:
+        self._formatter.format()
+
+        self._formatter.expect_to_have_been_called_with("uvx ruff format")

{instant_python-0.6.2 → instant_python-0.8.0}/uv.lock

@@ -378,7 +378,7 @@ wheels = [
 
 [[package]]
 name = "instant-python"
-version = "0.6.2"
+version = "0.8.0"
 source = { editable = "." }
 dependencies = [
     { name = "jinja2" },