instant-python 0.25.0__tar.gz → 0.26.0__tar.gz

{instant_python-0.25.0 → instant_python-0.26.0}/.github/workflows/pages.yml

@@ -77,4 +77,4 @@ jobs:
 
       - name: 🚀 Deploy to GitHub Pages
         id: deployment
-        uses: actions/deploy-pages@cd2ce8fcbc39b97be8ca5fce6e763baed58fa128 # v5
+        uses: actions/deploy-pages@368f82528645a54fb793d4d04e342629a3f51346 # v5

{instant_python-0.25.0 → instant_python-0.26.0}/.github/workflows/release.yml

@@ -75,3 +75,58 @@ jobs:
 
       - name: 🚀 Publish
         uses: pypa/gh-action-pypi-publish@release/v1
+
+  build-binaries:
+    name: Build binary (${{ matrix.target }})
+    needs:
+      - release
+    if: needs.release.outputs.released == 'true' || github.event_name == 'release'
+    strategy:
+      matrix:
+        include:
+          - runner: macos-14
+            target: aarch64-apple-darwin
+            ext: ""
+          - runner: ubuntu-latest
+            target: x86_64-unknown-linux-gnu
+            ext: ""
+          - runner: ubuntu-24.04-arm
+            target: aarch64-unknown-linux-gnu
+            ext: ""
+          - runner: windows-latest
+            target: x86_64-pc-windows-msvc
+            ext: ".exe"
+    runs-on: ${{ matrix.runner }}
+    permissions:
+      contents: write
+
+    steps:
+      - name: 🛡️ Harden runner
+        uses: step-security/harden-runner@e14015d583714f6e62063499dc959a02595150a1 # v2.21.1
+        with:
+          egress-policy: audit
+
+      - name: 📥 Checkout the repository
+        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1  # v7.0.1
+        with:
+          fetch-depth: 0
+          persist-credentials: false
+          ref: refs/tags/${{ needs.release.outputs.tag }}
+
+      - name: 🦀 Setup Rust toolchain
+        uses: dtolnay/rust-toolchain@6bed0761d98439e5a578e2877258200ad565ba87 # stable
+        with:
+          targets: ${{ matrix.target }}
+
+      - name: 🛠️ Setup environment
+        uses: ./.github/actions/setup_environment
+
+      - name: 🏃 Build binary
+        env:
+          CARGO_BUILD_TARGET: ${{ matrix.target }}
+        run: uvx hatch build -t binary
+
+      - name: 📤 Upload release asset
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: gh release upload ${{ needs.release.outputs.tag }} dist/app/ipy-${{ matrix.target }}${{ matrix.ext }} --clobber

{instant_python-0.25.0 → instant_python-0.26.0}/CHANGELOG.md

@@ -2,6 +2,28 @@
 
 <!-- version list -->
 
+## v0.26.0 (2026-09-08)
+
+### ✨ Features
+
+- **schema**: Remove year field and add missing built in features in ipy schema file
+  ([`f365f88`](https://github.com/dimanu-py/instant-python/commit/f365f88294745570c7cc7b5f7af9b2a613dc3d42))
+
+### ⚙️ Build System
+
+- Create installation script for Windows
+  ([`aee3d6e`](https://github.com/dimanu-py/instant-python/commit/aee3d6eac108569037c24687ef5a1925cc8eb58c))
+
+- Create installation script for Apple Silicon and Linux
+  ([`f431d2e`](https://github.com/dimanu-py/instant-python/commit/f431d2ec8c767be06dbd57a2c668f72c2678f9c2))
+
+- Bump click to fix vulnerability
+  ([`1c83b66`](https://github.com/dimanu-py/instant-python/commit/1c83b66ab31665dfe44a59221271767adb188249))
+
+- Bump python-semantic-release
+  ([`3e3c7b2`](https://github.com/dimanu-py/instant-python/commit/3e3c7b2c1d0c578184f3cb707d86d8d3fd1dc7e8))
+
+
 ## v0.25.0 (2026-09-06)
 
 ### ✨ Features

{instant_python-0.25.0 → instant_python-0.26.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: instant-python
-Version: 0.25.0
+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.25.0 → instant_python-0.26.0}/README.md

@@ -31,6 +31,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.26.0/docs/documentation/getting_started/installation.md

@@ -0,0 +1,83 @@
+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.
+
+!!! note "Supported Python Versions"
+    Instant Python tries to support the latest Python versions, we officially support from Python 3.10 to 3.13.
+    Older versions of Python may work, but they are not guaranteed to be compatible.
+
+## Installation Methods
+
+### Install script (recommended)
+
+The recommended way to install `instant-python` is via the install script. It downloads a self-contained `ipy` binary with
+Python bundled in, so **no local Python installation is required** to install or run it.
+
+**macOS / Linux**
+
+```bash
+curl -LsSf https://raw.githubusercontent.com/dimanu-py/instant-python/main/scripts/install.sh | sh
+```
+
+By default the binary is installed to `~/.local/bin`. You can override this with the `IPY_BIN_DIR` environment variable:
+
+```bash
+IPY_BIN_DIR="$HOME/bin" curl -LsSf https://raw.githubusercontent.com/dimanu-py/instant-python/main/scripts/install.sh | sh
+```
+
+**Windows**
+
+```powershell
+powershell -ExecutionPolicy ByPass -c "irm https://raw.githubusercontent.com/dimanu-py/instant-python/main/scripts/install.ps1 | iex"
+```
+
+This adds `%USERPROFILE%\.local\bin` to your user `PATH` automatically; restart your terminal afterwards so it picks up the
+change. You can override the install directory with the `IPY_BIN_DIR` environment variable.
+
+!!! note "Supported platforms"
+    The install script currently provides prebuilt binaries for macOS (Apple Silicon), Linux (x86_64 and arm64), and Windows
+    (x86_64). On other platforms (Intel Mac, Windows on ARM), use one of the alternative methods below.
+
+### Other installation methods
+
+If your platform isn't covered by the install script, or you prefer to manage `instant-python` as a regular Python package,
+you can install it with `uv`, `pipx`, or `pip` instead.
+
+#### Using `uv`
+
+If you already use [uv](https://docs.astral.sh/uv/) to manage Python tools, you can install `instant-python` with `uv tool
+install`, which installs it in an isolated environment just like `pipx`.
+
+```bash
+uv tool install instant-python
+```
+
+#### Using `pipx`
+
+`pipx` installs Python applications in isolated environments, ensuring that they do not interfere with other Python applications.
+
+```bash
+pipx install instant-python
+```
+
+If you do not have `pipx` installed, you can install it using `pip`.
+
+```bash
+pip install --user pipx
+```
+
+#### Using `pyenv`
+
+If you already manage your Python versions using a tool like Pyenv, you can install `instant-python` using `pip` with
+pyenv's global Python version.
+
+```bash
+pip install instant-python
+```
+
+A guide to install and configure pyenv can be found [here](https://github.com/pyenv/pyenv?tab=readme-ov-file#installation)
+
+## Next steps
+
+Now that you have installed `instant-python` you can advance to the [first steps](first_steps.md)
+section to learn the basic features of `instant-python` and create your first project.

{instant_python-0.25.0 → instant_python-0.26.0}/docs/documentation/home/index.md

@@ -24,6 +24,20 @@ commands like `ng new` or `create-react-app`, but for Python projects.
 
 </td></tr></table></div>
 
+## Quick Start
+
+Once [installed](../getting_started/installation.md), 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](../getting_started/first_steps.md) guide for a full walkthrough.
+
 ## Navigation Guide
 
 This section provides a high-level overview of the `instant-python` documentation

instant_python-0.26.0/instant_python/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.26.0"

{instant_python-0.25.0 → instant_python-0.26.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "instant-python"
-version = "0.25.0"
+version = "0.26.0"
 description = "Instant boilerplate generation for Python projects"
 readme = "README.md"
 license = { file = "LICENSE" }
@@ -47,6 +47,11 @@ ipy = "instant_python.cli.cli:app"
 [project.optional-dependencies]
 build = ["uv>=0.7.21"]
 
+[tool.hatch.build.targets.binary]
+scripts = ["ipy"]
+python-version = "3.12"
+pyapp-version = "0.29.0"
+
 
 [dependency-groups]
 dev = [

{instant_python-0.25.0 → instant_python-0.26.0}/schemas/ipy-schema.json

@@ -61,12 +61,6 @@
           "type": "string",
           "description": "Package and dependency manager",
           "enum": ["uv", "pdm"]
-        },
-        "year": {
-          "type": "integer",
-          "description": "Year for license and copyright (defaults to current year)",
-          "minimum": 2000,
-          "maximum": 2100
         }
       }
     },
@@ -153,7 +147,9 @@
               "fastapi_application",
               "precommit_hook",
               "citation_file",
-              "security_file"
+              "security_file",
+              "ai_agents",
+              "custom_documentation"
             ]
           },
           "uniqueItems": true,

instant_python-0.26.0/scripts/install.ps1

@@ -0,0 +1,81 @@
+# Install the latest instant-python (ipy) release binary for Windows.
+#
+# Usage:
+#
+#   powershell -ExecutionPolicy ByPass -c "irm https://raw.githubusercontent.com/dimanu-py/instant-python/main/scripts/install.ps1 | iex"
+#
+# Overridable via env vars:
+#   IPY_BIN_DIR   install destination directory (default: $env:USERPROFILE\.local\bin)
+
+$ErrorActionPreference = "Stop"
+
+$Repo = "dimanu-py/instant-python"
+$Target = "x86_64-pc-windows-msvc"
+$BinDir = if ($env:IPY_BIN_DIR) { $env:IPY_BIN_DIR } else { Join-Path $env:USERPROFILE ".local\bin" }
+$Dest = Join-Path $BinDir "ipy.exe"
+
+# --- confirm the current machine matches our only prebuilt target -----------
+function Confirm-SupportedArchitecture {
+    $arch = $env:PROCESSOR_ARCHITECTURE
+    if ($arch -ne "AMD64") {
+        Write-Error "ipy: no prebuilt binary for Windows-$arch. Install via 'uv tool install instant-python' or pipx/pip instead - see https://dimanu-py.github.io/instant-python/getting_started/installation/"
+        exit 1
+    }
+}
+
+# --- download the matching release asset -------------------------------------
+function Get-Binary {
+    param([string]$Destination)
+
+    $url = "https://github.com/$Repo/releases/latest/download/ipy-${Target}.exe"
+    Write-Host "ipy: downloading latest release for $Target ..."
+    Invoke-WebRequest -Uri $url -OutFile $Destination -UseBasicParsing
+}
+
+# --- move the binary into place ------------------------------------------------
+function Install-Binary {
+    param([string]$Source)
+
+    Write-Host "ipy: installing to $Dest ..."
+    New-Item -ItemType Directory -Force -Path $BinDir | Out-Null
+    Move-Item -Force -Path $Source -Destination $Dest
+}
+
+# Persist the install dir on the user's PATH so `ipy` works in new terminals.
+function Add-InstallDirToPath {
+    $userPath = [Environment]::GetEnvironmentVariable("Path", "User")
+    $pathEntries = $userPath -split ";" | Where-Object { $_ -ne "" }
+
+    if ($pathEntries -notcontains $BinDir) {
+        $newPath = if ($userPath) { "$userPath;$BinDir" } else { $BinDir }
+        [Environment]::SetEnvironmentVariable("Path", $newPath, "User")
+        Write-Host "ipy: added $BinDir to your user PATH. Restart your terminal to pick it up."
+    }
+
+    if (($env:Path -split ";") -notcontains $BinDir) {
+        $env:Path = "$env:Path;$BinDir"
+    }
+}
+
+function Confirm-Installation {
+    & $Dest --version
+}
+
+function Main {
+    Confirm-SupportedArchitecture
+
+    $tmp = Join-Path ([System.IO.Path]::GetTempPath()) ([System.IO.Path]::GetRandomFileName())
+    New-Item -ItemType Directory -Force -Path $tmp | Out-Null
+    try {
+        $download = Join-Path $tmp "ipy.exe"
+        Get-Binary -Destination $download
+        Install-Binary -Source $download
+        Add-InstallDirToPath
+        Confirm-Installation
+    }
+    finally {
+        Remove-Item -Recurse -Force $tmp -ErrorAction SilentlyContinue
+    }
+}
+
+Main

instant_python-0.26.0/scripts/install.sh

@@ -0,0 +1,87 @@
+#!/usr/bin/env sh
+# Install the latest instant-python (ipy) release binary for the current platform.
+#
+# Usage:
+#
+#   curl -LsSf https://raw.githubusercontent.com/dimanu-py/instant-python/main/scripts/install.sh | sh
+#
+# Overridable via env vars:
+#   IPY_BIN_DIR   install destination directory (default: $HOME/.local/bin)
+set -eu
+
+REPO="dimanu-py/instant-python"
+BIN_DIR="${IPY_BIN_DIR:-$HOME/.local/bin}"
+DEST="$BIN_DIR/ipy"
+
+# --- detect platform -> release target triple --------------------------------
+detect_target() {
+  os="$(uname -s)"
+  arch="$(uname -m)"
+  case "$os-$arch" in
+    Darwin-arm64)              target="aarch64-apple-darwin" ;;
+    Linux-x86_64)              target="x86_64-unknown-linux-gnu" ;;
+    Linux-aarch64|Linux-arm64) target="aarch64-unknown-linux-gnu" ;;
+    *)
+      echo "ipy: no prebuilt binary for $os-$arch." >&2
+      echo "ipy: install via pipx or pip instead - see https://dimanu-py.github.io/instant-python/getting_started/installation/" >&2
+      exit 1
+      ;;
+  esac
+}
+
+# --- download the matching release asset --------------------------------------
+download_binary() {
+  destination="$1"
+
+  echo "ipy: downloading latest release for $target ..." >&2
+  curl -fsSL -o "$destination" "https://github.com/$REPO/releases/latest/download/ipy-$target"
+}
+
+# --- move the binary into place and make it executable ------------------------
+install_binary() {
+  source="$1"
+
+  echo "ipy: installing to $DEST ..." >&2
+  mkdir -p "$BIN_DIR"
+  mv "$source" "$DEST"
+  chmod +x "$DEST"
+}
+
+# macOS: clear quarantine (no-op if absent) and ad-hoc sign so Gatekeeper allows it.
+macos_allow_execution() {
+  if [ "$os" = "Darwin" ]; then
+    xattr -d com.apple.quarantine "$DEST" 2>/dev/null || true
+    codesign --force --deep --sign - "$DEST"
+  fi
+}
+
+verify_installation() {
+  "$DEST" --version
+}
+
+# Warn the user if the install directory isn't already on their PATH.
+warn_if_not_on_path() {
+  case ":$PATH:" in
+    *":$BIN_DIR:"*) ;;
+    *)
+      echo "" >&2
+      echo "ipy: installed to $DEST, but $BIN_DIR is not on your PATH." >&2
+      echo "ipy: add this to your shell profile: export PATH=\"$BIN_DIR:\$PATH\"" >&2
+      ;;
+  esac
+}
+
+main() {
+  tmp="$(mktemp -d)"
+  trap 'rm -rf "$tmp"' EXIT
+  download="$tmp/ipy"
+
+  detect_target
+  download_binary "$download"
+  install_binary "$download"
+  macos_allow_execution
+  verify_installation
+  warn_if_not_on_path
+}
+
+main "$@"

{instant_python-0.25.0 → instant_python-0.26.0}/uv.lock

@@ -410,11 +410,14 @@ wheels = [
 
 [[package]]
 name = "click"
-version = "8.5.0"
+version = "8.3.3"
 source = { registry = "https://pypi.org/simple" }
-sdist = { url = "https://files.pythonhosted.org/packages/c7/0e/7fa0ef50764b67090eca4114772a2abf8b6148198475e54c660b97caeee6/click-8.5.0.tar.gz", hash = "sha256:ba0d2089de75ea0310e2dde03160e6ca10009947fb95a182f9b54021bb272e34", size = 382235, upload-time = "2026-08-26T13:33:14.56Z" }
+dependencies = [
+    { name = "colorama", marker = "sys_platform == 'win32'" },
+]
+sdist = { url = "https://files.pythonhosted.org/packages/bb/63/f9e1ea081ce35720d8b92acde70daaedace594dc93b693c869e0d5910718/click-8.3.3.tar.gz", hash = "sha256:398329ad4837b2ff7cbe1dd166a4c0f8900c3ca3a218de04466f38f6497f18a2", size = 328061, upload-time = "2026-04-22T15:11:27.506Z" }
 wheels = [
-    { url = "https://files.pythonhosted.org/packages/58/50/6c0d534c5f134586a8e1ba4e330569e32f057e33372ae556463212fb4cd3/click-8.5.0-py3-none-any.whl", hash = "sha256:255bc9599cf7748b4b1a446ccc735421bd08a2ae529a8b88597d3de5664ee360", size = 125251, upload-time = "2026-08-26T13:33:12.928Z" },
+    { url = "https://files.pythonhosted.org/packages/ae/44/c1221527f6a71a01ec6fbad7fa78f1d50dfa02217385cf0fa3eec7087d59/click-8.3.3-py3-none-any.whl", hash = "sha256:a2bf429bb3033c89fa4936ffb35d5cb471e3719e1f3c8a7c3fff0b8314305613", size = 110502, upload-time = "2026-04-22T15:11:25.044Z" },
 ]
 
 [[package]]
@@ -823,7 +826,7 @@ wheels = [
 
 [[package]]
 name = "instant-python"
-version = "0.25.0"
+version = "0.26.0"
 source = { editable = "." }
 dependencies = [
     { name = "click" },

instant_python-0.25.0/docs/documentation/getting_started/installation.md

@@ -1,40 +0,0 @@
-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.
-
-!!! note "Supported Python Versions"
-    Instant Python tries to support the latest Python versions, we officially support from Python 3.10 to 3.13.
-    Older versions of Python may work, but they are not guaranteed to be compatible.
-
-## Installation Methods
-
-### Using `pipx`
-
-The recommended way to install `instant-python` is using `pipx`. `pipx` installs Python applications in isolated environments, ensuring that
-they do not interfere with other Python applications.
-
-```bash
-pipx install instant-python
-```
-
-If you do not have `pipx` installed, you can install it using `pip`.
-
-```bash
-pip install --user pipx
-```
-
-### Using `pyenv`
-
-If you already manage your Python versions using a tool like Pyenv, you can install `instant-python` using `pip` with
-pyenv's global Python version.
-
-```bash
-pip install instant-python
-```
-
-A guide to install and configure pyenv can be found [here](https://github.com/pyenv/pyenv?tab=readme-ov-file#installation)
-
-## Next steps
-
-Now that you have installed `instant-python` you can advance to the [first steps](first_steps.md)
-section to learn the basic features of `instant-python` and create your first project.

instant_python-0.25.0/instant_python/__init__.py

@@ -1 +0,0 @@
-__version__ = "0.25.0"