instant-python 0.7.0__tar.gz → 0.8.1__tar.gz

{instant_python-0.7.0 → instant_python-0.8.1}/CHANGELOG.md

@@ -1,3 +1,23 @@
+## 0.8.1 (2025-07-01)
+
+### 🐛 Bug Fixes
+
+- **git**: modify command to make initial commit so Windows system does not interpret it as three different commands
+
+## 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

{instant_python-0.7.0 → instant_python-0.8.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: instant-python
-Version: 0.7.0
+Version: 0.8.1
 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.7.0 → instant_python-0.8.1}/docs/guide/command_init.md

@@ -267,7 +267,12 @@ some common exceptions that you can use in your project:
 ### Makefile
 
 A Makefile is a common tool to run tasks in your project. This feature is specially useful when automating tasks and
-avoid remembering all the commands. The default Makefile will include the following commands:
+avoid remembering all the commands.
+
+!!! warning
+    If you are running `instant-python` in a Windows environment, the Makefile will not work out of the box. You would need
+    to install a tool like [GNU Make for Windows](https://gnuwin32.sourceforge.net/packages/make.htm) or use a different task runner.
+The default Makefile will include the following commands:
 
 | Command           | Description                              |
 |-------------------|------------------------------------------|

{instant_python-0.7.0 → instant_python-0.8.1}/docs/home/getting_started.md

@@ -12,9 +12,6 @@ check the [Commands](../guide/command_config.md) section.
 
 ## Installation
 
-!!! important
-    For the moment, `instant-python` is only supported in Unix-like systems. Windows support is coming soon.
-
 To ensure a clean and isolated environment, we recommend installing `instant-python` using a virtual environment. At your
 own risk, you can install it at your system Python installation, but this is not recommended.
 Below are the preferred installation methods.

{instant_python-0.7.0 → instant_python-0.8.1}/docs/home/index.md

@@ -43,9 +43,6 @@ For detailed instructions and examples, please refer to the [Commands documentat
 
 ## Installation
 
-!!! important
-    For the moment, `instant-python` is only supported in Unix-like systems. Windows support is coming soon.
-
 The latest version of `instant-python` can be installed from PyPI:
 
 ```bash

{instant_python-0.7.0 → instant_python-0.8.1}/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.7.0 → instant_python-0.8.1}/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.7.0 → instant_python-0.8.1}/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.7.0 → instant_python-0.8.1}/instant_python/git/git_configurer.py

@@ -29,7 +29,7 @@ class GitConfigurer:
 
     def _make_initial_commit(self) -> None:
         self._run_command(command="git add .")
-        self._run_command(command="git commit -m '🎉 chore: initial commit'")
+        self._run_command(command='git commit -m "🎉 chore: initial commit"')
 
     def _run_command(self, command: str) -> None:
         subprocess.run(

{instant_python-0.7.0 → instant_python-0.8.1}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "instant-python"
-version = "0.7.0"
+version = "0.8.1"
 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.7.0 → instant_python-0.8.1}/test/git/test_git_configurer.py

@@ -33,7 +33,7 @@ class TestGitConfigurer:
 
         self._git_configurer.expect_to_have_been_called_with(
             "git add .",
-            "git commit -m '🎉 chore: initial commit'",
+            'git commit -m "🎉 chore: initial commit"',
         )
 
     def test_should_setup_git_repository(self) -> None:
@@ -49,5 +49,5 @@ class TestGitConfigurer:
             "git config user.name test_user",
             "git config user.email test_email@gmail.com",
             "git add .",
-            "git commit -m '🎉 chore: initial commit'",
+            'git commit -m "🎉 chore: initial commit"',
         )

{instant_python-0.7.0 → instant_python-0.8.1}/uv.lock

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