instant-python 0.19.1__tar.gz → 0.20.0__tar.gz

{instant_python-0.19.1 → instant_python-0.20.0}/.github/actions/python_setup/action.yml

@@ -19,7 +19,5 @@ runs:
       shell: bash
 
     - name: 📦 Install dependencies
-      run: |
-        uv sync --all-groups
-        uv run -m pre_commit install --hook-type pre-commit --hook-type commit-msg --hook-type pre-push
+      run: make install
       shell: bash

{instant_python-0.19.1 → instant_python-0.20.0}/.github/workflows/ci.yml

@@ -31,7 +31,7 @@ jobs:
 
       - name: 🧐 Check linting
         id: check_lint
-        run: uvx ruff check --exclude "instant_python/templates,test/**/resources/**" instant_python test
+        run: make check-lint
 
   format:
     name: format
@@ -54,7 +54,7 @@ jobs:
 
       - name: 🧐 Check code format
         id: check_format
-        run: uvx ruff format --check --exclude "instant_python/templates,test/**/resources/**" instant_python test
+        run: make check-format
 
   analyze-code-quality:
     name: analyze-code-quality

{instant_python-0.19.1 → instant_python-0.20.0}/CHANGELOG.md

@@ -2,6 +2,77 @@
 
 <!-- version list -->
 
+## v0.20.0 (2025-12-05)
+
+### ✨ Features
+
+- **schema**: Add JSON schema for custom project template structure to enable syntax and key/value
+  detection
+  ([`bf918b5`](https://github.com/dimanu-py/instant-python/commit/bf918b5b1efdcb9ddc38786814a5038144ca958b))
+
+- **schema**: Add JSON schema for instant-python project configuration to enable syntax and
+  key/value detection when modifying ipy config file manually
+  ([`2e3d4f7`](https://github.com/dimanu-py/instant-python/commit/2e3d4f786020ead95324784497015e698477a891))
+
+- **templates**: Add autostyle command to makefile to automatically format, lint and commit modified
+  files
+  ([`96c4610`](https://github.com/dimanu-py/instant-python/commit/96c46109c811198b70598df2c9f3e0674f6be1e7))
+
+- **initialize**: Implement 'write' method in yaml config repository to be able to write ipy config
+  file in working directory
+  ([`ca04b4c`](https://github.com/dimanu-py/instant-python/commit/ca04b4c97392970399ed7b8a6e3a86984ed6779b))
+
+- **initialize**: Add 'write' method to config repository to be able to use it with config command
+  and move it to shared
+  ([`e081a34`](https://github.com/dimanu-py/instant-python/commit/e081a342ccac66e45cef0cad728681c5aa9f301d))
+
+### ⚙️ Build System
+
+- **makefile**: Add command to makefile to automatically format, lint and commit modified files
+  ([`2837703`](https://github.com/dimanu-py/instant-python/commit/28377039628f755b503192aef85723f3e3b4704c))
+
+- **pyproject**: Add posthog dependency
+  ([`b3df1c0`](https://github.com/dimanu-py/instant-python/commit/b3df1c0587709a39e9e702142bdad4e8e293b07a))
+
+- **makefile**: Modify add-dep and remove-dep commands in makefile to not need scripts files
+  ([`b9d5286`](https://github.com/dimanu-py/instant-python/commit/b9d528636f5a051c865f4ea45196443ff322b55e))
+
+### ♻️ Refactoring
+
+- **templates**: Rename all templates for project structure to remove the '.j2' extension as it is
+  not need it
+  ([`cde9f87`](https://github.com/dimanu-py/instant-python/commit/cde9f87670273e6711fd08919c525208e7075fd9))
+
+- **initialize**: Modify file name for project structure template to not include j2 extension
+  ([`e8cd1f1`](https://github.com/dimanu-py/instant-python/commit/e8cd1f1aadb637f0a359783f11f95b164ca4cbd8))
+
+- **cli**: Modify main callback to print ipy help if no subcommand is called
+  ([`1784a3d`](https://github.com/dimanu-py/instant-python/commit/1784a3d129253cd197640680fbd85351ff074ec8))
+
+- **initialize**: Move config repository port and its adapter to shared folder so it can be properly
+  shared among commands
+  ([`438f89c`](https://github.com/dimanu-py/instant-python/commit/438f89cdf75ff58ce0477e88a54cad55ad4e93ae))
+
+- **config**: Remove legacy config writer now that its behavior has been unified in the config
+  repository
+  ([`3bcd3c9`](https://github.com/dimanu-py/instant-python/commit/3bcd3c9d858e342d9deca9bdc7bcd5db766de94b))
+
+- **config**: Extract semantic method to keep use case with the same abstraction level and make it
+  more readable
+  ([`7077e6a`](https://github.com/dimanu-py/instant-python/commit/7077e6a50a23df5e3d080b89265a935d83d8d68c))
+
+- **config**: Modify config generator dependency to receive a config repository instead of a config
+  writer
+  ([`89ed351`](https://github.com/dimanu-py/instant-python/commit/89ed35135d679a4fb4375eece5329162c454fb91))
+
+- **initialize**: Modify 'write' method so it uses absolute config file path instead of creating it
+  ([`5acc795`](https://github.com/dimanu-py/instant-python/commit/5acc795ba127292d5144d18da3ba718faf880b9e))
+
+- **shared**: Make default config file path absolute from users root folder to avoid incorrect
+  destination and relative path errors
+  ([`074e4a7`](https://github.com/dimanu-py/instant-python/commit/074e4a76f5319f2d167243935ca449a3ff80ca10))
+
+
 ## v0.19.1 (2025-11-27)
 
 ### 🪲 Bug Fixes

{instant_python-0.19.1 → instant_python-0.20.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: instant-python
-Version: 0.19.1
+Version: 0.20.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/
@@ -220,6 +220,7 @@ Classifier: Topic :: System :: Installation/Setup
 Classifier: Topic :: System :: Shells
 Requires-Python: >=3.9
 Requires-Dist: jinja2>=3.1.6
+Requires-Dist: posthog>=6.9.3
 Requires-Dist: pyyaml>=6.0.2
 Requires-Dist: questionary>=2.1.0
 Requires-Dist: typer>=0.15.1

{instant_python-0.19.1 → instant_python-0.20.0}/docs/guide/command_config.md

@@ -9,6 +9,7 @@ project.
 
 - [Overview](#overview) - What the config command does
 - [Usage](#usage) - How to run the config command
+- [JSON Schema Support](#json-schema-support) - IDE autocompletion and validation
 - [Configuration File Structure](#configuration-file-structure-and-restrictions) - All available options and their restrictions
     - [General](#general) - Project metadata
     - [Template](#template) - Project structure and features
@@ -113,6 +114,69 @@ Each dependency can have the following fields and restrictions:
 | `development` | Whether the dependency is a development dependency. | Must be either `true` or `false`.          | No                    |
 | `group`      | The development dependency group.                 | Only available if `development` is `true`. | Based on restrictions |
 
+## JSON Schema Support
+
+`instant-python` provides a JSON Schema to help you write and validate your configuration files with autocompletion and validation in your IDE.
+
+### What is a JSON Schema?
+
+A JSON Schema is a specification that defines the structure and validation rules for JSON and YAML files. By using a schema, your IDE can:
+
+- **Autocomplete** field names and values
+- **Validate** your configuration in real-time
+- **Show inline documentation** for each field
+- **Detect errors** before running the command
+
+### How to Use the Schema
+
+The schema is available at:
+```
+https://raw.githubusercontent.com/dimanu-py/instant-python/main/schemas/ipy-schema.json
+```
+
+!!! tip "Schema autodetection"
+If your configuration file is named `ipy.yml`, some IDEs may automatically detect and apply the schema
+from [SchemaStore](https://www.schemastore.org/). However, as it may take some time to updated and listed there,
+we recommend configuring it manually to ensure you are using the latest version.
+
+#### For Visual Studio Code
+
+Add the following line at the top of your `ipy.yml` file:
+
+```yaml
+# yaml-language-server: $schema=https://raw.githubusercontent.com/dimanu-py/instant-python/main/schemas/ipy-schema.json
+
+general:
+  slug: my-project
+  # ...
+```
+
+Alternatively, you can configure it globally in your VS Code settings (`.vscode/settings.json`):
+
+```json
+{
+  "yaml.schemas": {
+    "https://raw.githubusercontent.com/dimanu-py/instant-python/main/schemas/ipy-schema.json": "ipy.yml"
+  }
+}
+```
+
+#### For PyCharm / IntelliJ IDEA
+
+1. Open your `ipy.yml` file
+2. At the top of the file, add:
+   ```yaml
+   # yaml-language-server: $schema=https://raw.githubusercontent.com/dimanu-py/instant-python/main/schemas/ipy-schema.json
+   ```
+3. PyCharm will automatically detect and use the schema
+
+Alternatively, you can configure it manually:
+
+1. Go to **Settings** → **Languages & Frameworks** → **Schemas and DTDs** → **JSON Schema Mappings**
+2. Click the **+** button to add a new mapping
+3. Set the **Schema URL** to: `https://raw.githubusercontent.com/dimanu-py/instant-python/main/schemas/ipy-schema.json`
+4. Add a file pattern: `ipy.yml`
+
 ## Configuration File Examples
 
 ### Without initializing a git repository

{instant_python-0.19.1 → instant_python-0.20.0}/docs/guide/custom_projects.md

@@ -21,15 +21,15 @@ Follow these steps to create and use your first custom template:
 
     ```
     my_templates/
-    ├── main_structure.yml.j2    (required: defines your project structure)
+    ├── main_structure.yml    (required: defines your project structure)
     ├── authentication.py         (optional: custom file templates)
     ├── database.py              (optional: more templates)
     └── config.py                (optional: more templates)
     ```
 
-2. Define Your Project Structure: create a file named `main_structure.yml.j2` in your template folder. 
+2. Define Your Project Structure: create a file named `main_structure.yml` in your template folder. 
 
-    !!! warning "File *main_structure.yml.j2* is required"
+    !!! warning "File *main_structure.yml* is required"
         This is the **required** file that defines what your projects will look like.
 
 3. (Optional) Add Custom File Templates: create any additional template files (like `authentication.py`, `config.py`, etc.) that 
@@ -49,13 +49,13 @@ Your custom template must follow specific rules to generate projects correctly.
 
 ### File Naming & Location
 
-- **File name:** Your main structure file **must** be named exactly `main_structure.yml.j2`
+- **File name:** Your main structure file **must** be named exactly `main_structure.yml`
 - **Location:** This file **must** be at the root of your custom templates folder
 - **Format:** Must be a YAML file (`.yml` extension)
 
 ### Required Elements
 
-- **pyproject.toml:** You **must** include a `pyproject.toml` file in your `main_structure.yml.j2` structure. This 
+- **pyproject.toml:** You **must** include a `pyproject.toml` file in your `main_structure.yml` structure. This 
 is required for the dependency manager to work. If missing, `instant-python` will raise an error.
 
 ### Structure Definition Format
@@ -99,6 +99,71 @@ When you specify a `template` field for a file:
 
 This means you can optionally use built-in templates without having to provide your own.
 
+## JSON Schema Support for Custom Templates
+
+`instant-python` provides a JSON Schema specifically designed to help you create your `main_structure.yml` file with IDE assistance.
+
+### What is a JSON Schema?
+
+A JSON Schema is a specification that defines the structure and validation rules for JSON and YAML files. By using a schema when writing your custom template structure, your IDE can:
+
+- **Autocomplete** field names (like `name`, `type`, `python`, `children`, etc.)
+- **Validate** your structure definition in real-time
+- **Show inline documentation** explaining what each field does
+- **Detect errors** before generating your project (like missing required fields or invalid values)
+
+### How to Use the Schema
+
+The schema for custom template structures is available at:
+```
+https://raw.githubusercontent.com/dimanu-py/instant-python/main/schemas/main-structure-schema.json
+```
+
+!!! tip "Schema autodetection"
+If your configuration file is named `ipy.yml`, some IDEs may automatically detect and apply the schema
+from [SchemaStore](https://www.schemastore.org/). However, as it may take some time to updated and listed there,
+we recommend configuring it manually to ensure you are using the latest version.
+
+#### For Visual Studio Code
+
+Add the following line at the top of your `main_structure.yml` file:
+
+```yaml
+# yaml-language-server: $schema=https://raw.githubusercontent.com/dimanu-py/instant-python/main/schemas/main-structure-schema.json
+
+- name: src
+  type: directory
+  python: True
+  children:
+    # ...
+```
+
+Alternatively, you can configure it globally in your VS Code settings (`.vscode/settings.json`) for all your custom templates:
+
+```json
+{
+  "yaml.schemas": {
+    "https://raw.githubusercontent.com/dimanu-py/instant-python/main/schemas/main-structure-schema.json": "**/main_structure.yml"
+  }
+}
+```
+
+#### For PyCharm / IntelliJ IDEA
+
+1. Open your `main_structure.yml` file
+2. At the top of the file, add:
+   ```yaml
+   # yaml-language-server: $schema=https://raw.githubusercontent.com/dimanu-py/instant-python/main/schemas/main-structure-schema.json
+   ```
+3. PyCharm will automatically detect and use the schema
+
+Alternatively, you can configure it manually:
+
+1. Go to **Settings** → **Languages & Frameworks** → **Schemas and DTDs** → **JSON Schema Mappings**
+2. Click the **+** button to add a new mapping
+3. Set the **Schema URL** to: `https://raw.githubusercontent.com/dimanu-py/instant-python/main/schemas/main-structure-schema.json`
+4. Add a file pattern: `main_structure.yml`
+
 ## Examples
 
 ### Hexagonal Architecture Project
@@ -109,7 +174,7 @@ gitignore, README and pyproject files.
 !!! important
     Remember that the _pyproject.toml_ file is always required for `instant-python` to be able to set up the environment of your project.
 
-Create a file named `main_structure.yml.j2` in your templates folder with the following content:
+Create a file named `main_structure.yml` in your templates folder with the following content:
 
 ```yaml
 - name: src
@@ -189,7 +254,7 @@ def authenticate_user(username: str, password: str) -> bool:
     return username == "admin" and password == "secret"
 ```
 
-**Step 2:** Reference this template in your `main_structure.yml.j2`:
+**Step 2:** Reference this template in your `main_structure.yml`:
 
 ```yaml
 - name: src