instant-python 0.3.0__tar.gz → 0.4.0__tar.gz

{instant_python-0.3.0 → instant_python-0.4.0}/.github/workflows/release.yml

@@ -17,6 +17,7 @@ jobs:
           fetch-depth: 0
 
       - name: Bump version and update changelog
+        id: bump
         uses: commitizen-tools/commitizen-action@master
         with:
           github_token: ${{ secrets.CHANGELOG_TOKEN }}
@@ -34,19 +35,19 @@ jobs:
       - name: Get release tag
         id: release_tag
         run: |
-          if [ -z "${{ needs.bump_version.outputs.tag }}" ]; then
+          if [ -z "${{ needs.bump-version.outputs.tag }}" ]; then
             echo "No tag provided from bump version job. Running fallback command..."
             git fetch --tags
             echo "release_tag=$(git describe --tags --abbrev=0)" >> $GITHUB_OUTPUT
           else
             echo "Using tag provided from bump version job."
-            echo "release_tag=${{ needs.bump_version.outputs.tag }}" >> $GITHUB_OUTPUT
+            echo "release_tag=${{ needs.bump-version.outputs.tag }}" >> $GITHUB_OUTPUT
           fi
 
       - name: Extract Changelog for Release
         id: extract_changelog
         run: |
-          release="${{ steps.determine_tag.outputs.release_tag }}"
+          release="${{ steps.release_tag.outputs.release_tag }}"
           echo "Extracting changelog for tag: ${release}"
           
           awk -v tag="$release" '

{instant_python-0.3.0 → instant_python-0.4.0}/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 0.4.0 (2025-04-11)
+
+### ✨ Features
+
+- **template**: add README template and include in main structure
+
 ## 0.3.0 (2025-04-11)
 
 ### ✨ Features

{instant_python-0.3.0 → instant_python-0.4.0}/PKG-INFO

@@ -1,8 +1,8 @@
 Metadata-Version: 2.4
 Name: instant-python
-Version: 0.3.0
+Version: 0.4.0
 Summary: Instant boilerplate generation for Python projects
-Project-URL: documentation, https://dimanu-py.github.io/instant-python/
+Project-URL: documentation, https://dimanu-py.github.io/instant-python/welcome/
 Project-URL: repository, https://github.com/dimanu-py/instant-python/
 Author-email: dimanu-py <diegomtz126@gmail.com>
 License:                                  Apache License

{instant_python-0.3.0 → instant_python-0.4.0}/docs/getting-started/installation.md

@@ -1,7 +1,7 @@
 # Installation
 
 !!! important
-For the moment, `instant-python` is only supported in Unix-like systems. Windows support is coming soon.
+    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 you system Python installation, but this is not recommended.

{instant_python-0.3.0 → instant_python-0.4.0}/docs/guide/custom-templates.md

@@ -21,43 +21,60 @@ offers a Domain Driven Design, Clean Architecture and Standard templates.
 
 ## Examples
 
-???+ example 
-
-Let's imagine that you want to create a new project using a custom template with Hexagonal Architecture. 
+Let's imagine that you want to create a new project using a custom template with Cockburn-style Hexagonal Architecture,
+including a gitignore, README and mypy configuration files. 
 You can create a yaml file with the following content:
 
 ```yaml
 root:
   - name: src
     type: directory
-    python: true
-    children:
-      - name: domain
-        type: directory
-        python: true
-      - name: application
-        type: directory
-        python: true
-      - name: ports
-        type: directory
-        python: true
-      - name: adapters
-        type: directory
-        python: true
-  - name: test
-    type: directory
-    python: true
+    python: True
     children:
-      - name: domain
-        type: directory
-        python: true
-      - name: application
+      - name: driven_adapters
         type: directory
-        python: true
-      - name: ports
+        python: True
+        children:
+          - name: adapter_for_paying_spy
+            type: file
+            extension: .py
+          - name: adapter_for_obtaining_grates_stup
+            type: file
+            extension: .py
+      - name: driving_adapters
         type: directory
-        python: true
-      - name: adapters
+        python: True
+        children:
+          - name: adapter_for_checking_cars_test
+            type: file
+            extension: .py
+      - name: tax_calculator_app
         type: directory
-        python: true
+        python: True
+        children:
+          - name: driven_ports
+            type: directory
+            python: True
+            children:
+              - name: for_paying
+                type: file
+                extension: .py
+          - name: driving_ports
+            type: directory
+            python: True
+            children:
+              - name: for_checking_cars
+                type: file
+                extension: .py
+          - name: tax_calculator
+            type: directory
+            python: True
+  - name: .gitignore
+    type: file
+  - name: README
+    type: file
+    extension: .md
+  - name: mypy
+    type: file
+    extension: .ini
 ```

instant_python-0.4.0/instant_python/templates/boilerplate/README.md

@@ -0,0 +1,5 @@
+# {{ project-slug }}
+
+## Description
+
+{{ description }}

{instant_python-0.3.0 → instant_python-0.4.0}/instant_python/templates/project_structure/clean_architecture/main_structure.yml.j2

@@ -11,6 +11,7 @@ root:
   {{ macros.include_and_indent("project_structure/pyproject.yml.j2", 2) }}
   {% if git %}
   {{ macros.include_and_indent("project_structure/gitignore.yml.j2", 2) }}
+  {{ macros.include_and_indent("project_structure/readme.yml.j2", 2) }}
   {% endif %}
   {{ macros.include_and_indent("project_structure/python_version.yml.j2", 2) }}
   {% if "pytest" in dependencies %}

{instant_python-0.3.0 → instant_python-0.4.0}/instant_python/templates/project_structure/domain_driven_design/main_structure.yml.j2

@@ -11,6 +11,7 @@ root:
   {{ macros.include_and_indent("project_structure/pyproject.yml.j2", 2) }}
   {% if git %}
   {{ macros.include_and_indent("project_structure/gitignore.yml.j2", 2) }}
+  {{ macros.include_and_indent("project_structure/readme.yml.j2", 2) }}
   {% endif %}
   {{ macros.include_and_indent("project_structure/python_version.yml.j2", 2) }}
   {% if "pytest" in dependencies %}

instant_python-0.4.0/instant_python/templates/project_structure/readme.yml.j2

@@ -0,0 +1,3 @@
+- name: README
+  type: boilerplate_file
+  extension: .md

{instant_python-0.3.0 → instant_python-0.4.0}/instant_python/templates/project_structure/standard_project/main_structure.yml.j2

@@ -11,6 +11,7 @@ root:
   {{ macros.include_and_indent("project_structure/pyproject.yml.j2", 2) }}
   {% if git %}
   {{ macros.include_and_indent("project_structure/gitignore.yml.j2", 2) }}
+  {{ macros.include_and_indent("project_structure/readme.yml.j2", 2) }}
   {%  endif %}
   {{ macros.include_and_indent("project_structure/python_version.yml.j2", 2) }}
   {% if "pytest" in dependencies %}

{instant_python-0.3.0 → instant_python-0.4.0}/mkdocs.yml

@@ -1,5 +1,5 @@
 site_name: Instant Python Generator
-site_url: https://dimanu-py.github.io/instant-python/
+site_url: https://dimanu-py.github.io/instant-python/welcome
 site_description: >
   Get you Python project autogenerated, with the Python version you want,
   dependency manager, create automatically a git repository and even select

{instant_python-0.3.0 → instant_python-0.4.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "instant-python"
-version = "0.3.0"
+version = "0.4.0"
 description = "Instant boilerplate generation for Python projects"
 readme = "README.md"
 license = { file = "LICENSE" }
@@ -28,7 +28,7 @@ include = [
 ]
 
 [project.urls]
-documentation = "https://dimanu-py.github.io/instant-python/"
+documentation = "https://dimanu-py.github.io/instant-python/welcome/"
 repository = "https://github.com/dimanu-py/instant-python/"
 
 [project.scripts]

{instant_python-0.3.0 → instant_python-0.4.0}/uv.lock

@@ -240,7 +240,7 @@ wheels = [
 
 [[package]]
 name = "instant-python"
-version = "0.3.0"
+version = "0.4.0"
 source = { editable = "." }
 dependencies = [
     { name = "jinja2" },