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

instant_python-0.8.2/.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,67 @@
+name: 🐛 Bug Report
+description: Create a report to help us improve.
+labels:
+  - bug
+  - pending
+
+body:
+  - type: textarea
+    id: description
+    validations:
+      required: true
+    attributes:
+      label: ✏️ Description
+      description: |
+        Please provide a clear and concise description of the bug you are experiencing.
+        
+        Specify what is the expected behavior and what is actually happening. You can add
+        screenshots to help illustrate the issue.
+
+        Please provide as much detail as possible to make understanding and solving your problem as quick as possible. 🙏
+
+  - type: textarea
+    id: reproduce
+    attributes:
+      label:  ✅ Steps To Reproduce
+      render: Python
+      description: >
+        Please list the steps needed to reproduce the bug you are experiencing.
+
+        If applicable, please add a self-contained,
+        [minimal, reproducible, example](https://stackoverflow.com/help/minimal-reproducible-example)
+        demonstrating the bug.\
+
+      placeholder: >
+        # 1. Install the package using pip
+        # 2. Run the script with the following command:
+        #    python script.py
+        # 3. Observe the output\
+
+  - type: dropdown
+    id: python-version
+    attributes:
+      label: 🐍  Which version of Python are you using?
+      options:
+        - 3.8
+        - 3.9
+        - 3.10
+        - 3.11
+        - 3.12
+        - 3.13
+        - other
+    validations:
+      required: true
+
+  - type: input
+    id: ipy-version
+    validations:
+      required: true
+    attributes:
+      label: 📦 Which version of Instant Python are you using?
+
+  - type: input
+    id: os
+    validations:
+      required: true
+    attributes:
+      label: 🖥️  Which operating system are you using?

instant_python-0.8.2/.github/ISSUE_TEMPLATE/feature_request.yml

@@ -0,0 +1,21 @@
+name: 🚀 Feature Request
+description: Suggest a new idea for Instant Python.
+labels:
+  - enhancement
+  - pending
+
+body:
+  - type: textarea
+    id: description
+    validations:
+      required: true
+    attributes:
+      label: ✏️ Description
+      description: |
+        Please give as much detail as possible about the feature you would like to suggest.
+
+        You might like to add:
+        * A clear and concise description of the idea that should be implemented
+        * An example of how the feature should work
+        * Any relevant links or resources that can help understand the feature better
+        * A list of scenarios or validations that the feature should cover as well as any restrictions or limitations that should be considered

{instant_python-0.8.1 → instant_python-0.8.2}/.github/actions/python_setup/action.yml

@@ -9,12 +9,17 @@ outputs: {}
 runs:
   using: composite
   steps:
-    - uses: actions/setup-python@v5
+    - name: 🐍 Setup Python
+      uses: actions/setup-python@v5
       with:
         python-version: ${{ inputs.python-version }}
-    - name: Install dependency manager
+
+    - name: 🔨 Install dependency manager
       run: python -m pip install uv
       shell: bash
-    - name: Install dependencies
-      run: uv sync --all-groups
+
+    - 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
       shell: bash

instant_python-0.8.2/.github/pull_request_template.md

@@ -0,0 +1,30 @@
+# Description
+
+## Type of change
+
+- [ ] **✨ feat**: New feature (non-breaking change).
+- [ ] **🐛 fix**: Bug fix (non-breaking change).
+- [ ] **📝 docs**: Documentation update.
+- [ ] **♻️ refactor**: Code change that neither fixes a bug nor adds a new feature.
+- [ ] **⚡️ perf**: Performance improvement.
+- [ ] **🧪 test**: Update suite of tests.
+- [ ] **📦️ build**: Changes that affect the build system (new dependencies, tools, ...).
+- [ ] **💚 ci**: Pipeline changes (GitHub Actions, make commands, ...).
+- [ ] **💥 BREAKING CHANGE**: Feature, fix, ... that breaks backward compatibility.
+- [ ] **👽️ others**: Other type of change.
+
+## Related Issues / Discussions / Resources
+
+## Pre-merge Checklist
+
+- [ ] I have read and followed the [`Contributor Guidelines`](https://github.com/dimanu-py/instant-python/blob/main/docs/home/contributing.md).
+- [ ] My pull requests and commits follow the [Conventional Commits](https://www.conventionalcommits.org) and [Conventional Comments](https://conventionalcomments.org) guidelines.
+- [ ] My code follows the coding guidelines of the project ([PEP 8](https://peps.python.org/pep-0008), [PEP 257](https://peps.python.org/pep-0257), ...).
+- [ ] My changes generate no new warnings (execution, linter, formatter, ...).
+- [ ] I have updated the suite of tests required for this change.
+- [ ] I have made corresponding changes to the documentation.
+- [ ] I considered security & backwards-compatibility; if **breaking**, explain in the "Description" section above.
+
+## 📃 Additional Resources
+
+- [The Anatomy of a Perfect Pull Request](https://hugooodias.medium.com/the-anatomy-of-a-perfect-pull-request-567382bb6067)

instant_python-0.8.2/.github/workflows/ci.yml

@@ -0,0 +1,303 @@
+name: CI - Testing and Code analysis
+
+on:
+  push:
+    branches:
+      - main
+
+permissions:
+  contents: write
+  id-token: write
+
+jobs:
+  check_user:
+    name: check-user
+    runs-on: ubuntu-latest
+    outputs:
+      should_run: ${{ github.actor == 'dimanu-py' }}
+    steps:
+      - name: 🛡️ Harden runner
+        uses: step-security/harden-runner@6c439dc8bdf85cadbbce9ed30d1c7b959517bc49 # v2.12.2
+        with:
+          egress-policy: audit
+
+      - name: 👍 Check triggering user
+        run: echo "Workflow triggered by ${{ github.actor }}"
+
+  lint:
+    name: lint
+    runs-on: ubuntu-latest
+    needs: check_user
+    if: ${{ needs.check_user.outputs.should_run == 'true' }}
+    steps:
+      - name: 🛡️ Harden runner
+        uses: step-security/harden-runner@6c439dc8bdf85cadbbce9ed30d1c7b959517bc49 # v2.12.2
+        with:
+          egress-policy: audit
+
+      - name: 📥 Checkout the repository
+        uses: actions/checkout@v4
+        with:
+          ref: ${{ github.head_ref }}
+          fetch-depth: 0
+          persist-credentials: false
+
+      - name: 🛠️ Setup environment
+        uses: ./.github/actions/python_setup
+
+      - name: 🧐 Check linting
+        id: check_lint
+        run: |
+          git pull --rebase origin main
+          uvx ruff check --exclude "instant_python/templates,test/**/resources/**" instant_python test
+        continue-on-error: true
+
+      - name: 🚨 Auto fix lint errors
+        id: fix_lint
+        if: ${{ steps.check_lint.outcome == 'failure' }}
+        run: |
+          git pull --rebase origin main
+          uvx ruff check --fix --exclude "instant_python/templates,test/**/resources/**" instant_python test
+
+      - name: ✏️ Commit lint fixes
+        if: ${{ steps.fix_lint.outcome == 'success' }}
+        run: |
+          git config user.name ${{ vars.GIT_COMMITTER_NAME }}
+          git config user.email ${{ vars.GIT_COMMITTER_EMAIL }}
+
+          if git diff --quiet; then
+            echo "No changes to commit."
+          else
+            git add .
+            git commit -m "🚨 chore: fix linting issues via GitHub Actions"
+            git push
+          fi
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: 🧐 Check linting again
+        run: uvx ruff check --exclude "instant_python/templates,test/**/resources/**" instant_python test
+
+  format:
+    name: format
+    runs-on: ubuntu-latest
+    needs: check_user
+    if: ${{ needs.check_user.outputs.should_run == 'true' }}
+    steps:
+      - name: 🛡️ Harden runner
+        uses: step-security/harden-runner@6c439dc8bdf85cadbbce9ed30d1c7b959517bc49 # v2.12.2
+        with:
+          egress-policy: audit
+
+      - name: 📥 Checkout the repository
+        uses: actions/checkout@v4
+        with:
+          ref: ${{ github.head_ref }}
+          fetch-depth: 0
+          persist-credentials: false
+
+      - name: 🛠️ Setup environment
+        uses: ./.github/actions/python_setup
+
+      - name: 🧐 Check code format
+        id: check_format
+        run: |
+          git pull --rebase origin main
+          uvx ruff format --check --exclude "instant_python/templates,test/**/resources/**" instant_python test
+        continue-on-error: true
+
+      - name: 🎨 Auto format code
+        id: format_code
+        if: ${{ steps.check_format.outcome == 'failure' }}
+        run: |
+          git pull --rebase origin main
+          uvx ruff format --exclude "instant_python/templates,test/**/resources/**" instant_python test
+
+      - name: ✏️ Commit formatted code
+        if: ${{ steps.format_code.outcome == 'success' }}
+        run: |
+          git config user.name ${{ vars.GIT_COMMITTER_NAME }}
+          git config user.email ${{ vars.GIT_COMMITTER_EMAIL }}
+
+          if git diff --quiet; then
+            echo "No changes to commit."
+          else
+            git add .
+            git commit -m "🎨 style: format code via GitHub Actions"
+            git push
+          fi
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: 🧐 Check code format again
+        run: uvx ruff format --check --exclude "instant_python/templates,test/**/resources/**" instant_python test
+
+  analyze-code-quality:
+    name: analyze-code-quality
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      security-events: write
+
+    steps:
+      - name: 🛡️ Harden runner
+        uses: step-security/harden-runner@6c439dc8bdf85cadbbce9ed30d1c7b959517bc49 # v2.12.2
+        with:
+          egress-policy: audit
+
+      - name: 📥 Checkout the repository
+        uses: actions/checkout@v4
+        with:
+          ref: ${{ github.head_ref }}
+          fetch-depth: 0
+          persist-credentials: false
+
+      - name: ▶️ CodeQL Initialization
+        uses: github/codeql-action/init@181d5eefc20863364f96762470ba6f862bdef56b # v3.29.2
+        with:
+          languages: python
+          build-mode: none
+          queries: +security-extended,security-and-quality
+          config-file: ./codeql-config.yml
+
+      - name: 🧐 CodeQL Analysis
+        uses: github/codeql-action/analyze@181d5eefc20863364f96762470ba6f862bdef56b # v3.29.2
+        with:
+          category: '/language:python'
+
+
+  secrets:
+    name: secrets-scan
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      security-events: write
+      pull-requests: write
+
+    steps:
+      - name: 🛡️ Harden runner
+        uses: step-security/harden-runner@6c439dc8bdf85cadbbce9ed30d1c7b959517bc49 # v2.12.2
+        with:
+          egress-policy: audit
+
+      - name: 📥 Checkout the repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          persist-credentials: false
+
+      - name: 🛠️ Setup environment
+        uses: ./.github/actions/python_setup
+
+      - name: 🏃 Run secrets scanner
+        run: make secrets
+
+  audit:
+    name: audit-dependencies
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+
+    steps:
+      - name: 🛡️ Harden runner
+        uses: step-security/harden-runner@6c439dc8bdf85cadbbce9ed30d1c7b959517bc49 # v2.12.2
+        with:
+          egress-policy: audit
+
+      - name: 📥 Checkout the repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          persist-credentials: false
+
+      - name: 🛠️ Setup environment
+        uses: ./.github/actions/python_setup
+
+      - name: 🏃 Run audit
+        run: make audit
+
+  test:
+    name: test
+    runs-on: ubuntu-latest
+    steps:
+      - name: 🛡️ Harden runner
+        uses: step-security/harden-runner@6c439dc8bdf85cadbbce9ed30d1c7b959517bc49 # v2.12.2
+        with:
+          egress-policy: audit
+
+      - name: 📥 Checkout the repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          persist-credentials: false
+
+      - name: 🛠️ Setup environment
+        uses: ./.github/actions/python_setup
+
+      - name: 📦 Install test dependencies
+        run: uv pip install pytest pytest-cov
+
+      - name: 🏃 Run tests
+        run: uv run pytest --cov --cov-report=xml --cov-branch test -ra -s
+
+      - name: 📥 Upload coverage report to Codecov
+        uses: codecov/codecov-action@v5
+        with:
+          files: coverage.xml
+          flags: unittests
+          name: codecov-coverage
+          token: ${{ secrets.CODECOV_TOKEN }}
+          slug: dimanu-py/instant-python
+
+  rollback:
+    name: rollback
+    runs-on: ubuntu-latest
+    needs: [ test ]
+    if: ${{ always() && needs.test.result == 'failure' }}
+    steps:
+      - name: 🛡️ Harden runner
+        uses: step-security/harden-runner@6c439dc8bdf85cadbbce9ed30d1c7b959517bc49 # v2.12.2
+        with:
+          egress-policy: audit
+
+      - name: 📥 Checkout the repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          persist-credentials: false
+
+      - name: ⏪️ Reset to previous commit
+        run: |
+          git config user.name ${{ vars.GIT_COMMITTER_NAME }}
+          git config user.email ${{ vars.GIT_COMMITTER_EMAIL }}
+          git reset --hard ${{ github.event.before }}
+          git push --force-with-lease origin main
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+  tox-test:
+    name: tox
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: [ '3.9', '3.10', '3.11', '3.12', '3.13' ]
+    steps:
+      - name: 🛡️ Harden runner
+        uses: step-security/harden-runner@6c439dc8bdf85cadbbce9ed30d1c7b959517bc49 # v2.12.2
+        with:
+          egress-policy: audit
+
+      - name: 📥 Checkout the repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          persist-credentials: false
+
+      - name: 🛠️ Setup environment
+        uses: ./.github/actions/python_setup
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v4
+
+      - name: 🏃 Run tox
+        run: make tox

instant_python-0.8.2/.github/workflows/release.yml

@@ -0,0 +1,77 @@
+name: Release and Publish
+
+on:
+  workflow_dispatch:
+
+jobs:
+  release:
+    if: "!startsWith(github.event.head_commit.message, 'bump:')"
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      pull-requests: write
+
+    outputs:
+      released: ${{ steps.released.outputs.released }}
+      tag: ${{ steps.released.outputs.tag }}
+
+    steps:
+      - name: 🛡️ Harden runner
+        uses: step-security/harden-runner@6c439dc8bdf85cadbbce9ed30d1c7b959517bc49 # v2.12.2
+        with:
+          egress-policy: audit
+
+      - name: 📥 Checkout the repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          persist-credentials: false
+
+      - name: 🔖 Semantic Release
+        id: released
+        uses: python-semantic-release/python-semantic-release@2896129e02bb7809d2cf0c1b8e9e795ee27acbcf # v10.0.2
+        with:
+          build: false
+          push: true
+          changelog: true
+          commit: true
+          tag: true
+          vcs_release: true
+          config_file: pyproject.toml
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          git_committer_email: ${{ vars.GIT_COMMITTER_EMAIL }}
+          git_committer_name: ${{ vars.GIT_COMMITTER_NAME }}
+          ssh_public_signing_key: ${{ vars.SSH_PUBLIC_SIGNING_KEY }}
+          ssh_private_signing_key: ${{ secrets.SSH_PRIVATE_SIGNING_KEY }}
+
+  build-and-publish:
+    name: Publish Release to PyPI Workflow
+    needs: release
+    if: needs.release.result == 'success' && needs.release.outputs.released == 'true'
+    runs-on: ubuntu-latest
+    environment: release
+
+    permissions:
+      id-token: write
+
+    steps:
+      - name: 🛡️ Harden runner
+        uses: step-security/harden-runner@6c439dc8bdf85cadbbce9ed30d1c7b959517bc49 # v2.12.2
+        with:
+          egress-policy: audit
+
+      - name: 📥 Checkout the repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          persist-credentials: false
+          ref: refs/tags/${{ needs.release.outputs.tag }}
+
+      - name: 🛠️ Setup environment
+        uses: ./.github/actions/python_setup
+
+      - name: 🏃 Build package
+        run: uv build
+
+      - name: 🚀 Publish
+        uses: pypa/gh-action-pypi-publish@release/v1

instant_python-0.8.2/.pre-commit-config.yaml

@@ -0,0 +1,73 @@
+fail_fast: true
+
+default_language_version:
+  python: python3.12
+
+exclude: ^instant_python/templates/
+
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: cef0300fd0fc4d2a87a85fa2093c6b283ea36f4b # v5.0.0
+    hooks:
+      - id: check-added-large-files
+        name: 📦 Large Files Checker
+        args:
+          - --maxkb=100
+        stages:
+          - pre-commit
+
+      - id: check-case-conflict
+        name: 🔠 Case Conflict Checker
+        stages:
+          - pre-commit
+
+      - id: check-toml
+        name: 📄 TOML Files Checker
+        files: '.*\.toml'
+        stages:
+          - pre-commit
+
+      - id: check-yaml
+        name: 📄 YAML Files Checker
+        files: '.*\.ya?ml'
+        args:
+          - --unsafe
+        stages:
+          - pre-commit
+      - id: check-merge-conflict
+        name: 🔀 Merge Conflict Checker
+        stages:
+          - pre-commit
+
+  - repo: https://github.com/gitleaks/gitleaks
+    rev: 782f3104786efdce0f809bce8a9ff31f2fa1c9ed # v8.27.0
+    hooks:
+      - id: gitleaks
+        name: 🔍 Secrets Checker
+        entry: gitleaks detect --no-git --redact --verbose
+        stages:
+          - pre-commit
+
+  - repo: https://github.com/commitizen-tools/commitizen
+    rev: a0cc4901b0faaced74c713a9e355555fc4de0880 # v4.7.1
+    hooks:
+      - id: commitizen
+        name: 📝 Conventional Commit Message Checker
+        stages:
+          - commit-msg
+
+  - repo: local
+    hooks:
+      - id: lint
+        name: 🧹 Code Linter
+        entry: make check-lint
+        language: system
+        stages:
+          - pre-push
+
+      - id: format
+        name: 🎨 Code Formatter
+        entry: make check-format
+        language: system
+        stages:
+          - pre-push

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

@@ -1,3 +1,53 @@
+# CHANGELOG
+
+## v0.9.0 (2025-07-15)
+
+### 🪲 Bug Fixes
+
+- **render**: Create jinja environment with autoscape argument enabled to avoid potential XSS
+  attacks
+  ([`976d459`](https://github.com/dimanu-py/instant-python/commit/976d459538ae8eea403c65300304e6405fec46b6))
+
+- **templates**: Format correctly if statement in application.py template
+  ([`409d606`](https://github.com/dimanu-py/instant-python/commit/409d6064d97ef016c34dab57d3c9456a47e6542f))
+
+- **templates**: Include logger and migrator in fastapi application only if they are selected too
+  for DDD and standard project templates
+  ([`f5a8087`](https://github.com/dimanu-py/instant-python/commit/f5a80870d0ecdd2f47419ad5e51d20131649b422))
+
+- **templates**: Include logger and migrator in fastapi application only if they are selected as
+  built in feature too in clean architecture template
+  ([`191d81f`](https://github.com/dimanu-py/instant-python/commit/191d81fd8ace560f3a6359bc9cf767c73c310d50))
+
+### ⚙️ Build System
+
+- Update semantic release to not update major version if is zero and to allow 0 major version
+  ([`34d251e`](https://github.com/dimanu-py/instant-python/commit/34d251e8a57eafa595a0c54e314238f389218dd6))
+
+- Remove test hook in precommit config
+  ([`b8d451d`](https://github.com/dimanu-py/instant-python/commit/b8d451db1a024ae41a6958dbf9513801f3b69627))
+
+- Remove final echo from makefile commands to let output of the command itself inform the user
+  ([`cd895ad`](https://github.com/dimanu-py/instant-python/commit/cd895adacfe1e470a746165380369c9c365996e8))
+
+- Remove -e command from echo in makefile
+  ([`6a624a3`](https://github.com/dimanu-py/instant-python/commit/6a624a3cacf8b96adaeba20bb635b7e43d853002))
+
+- Exclude resources folder from being formatted or linted
+  ([`cf00038`](https://github.com/dimanu-py/instant-python/commit/cf000382ba13a0bc4dbda8eb346e9cdeb4fe4541))
+
+- Remove AST check from pre commit hook
+  ([`b46437e`](https://github.com/dimanu-py/instant-python/commit/b46437e804a1d54f13444e92827bd15d9fb2fd57))
+
+- Add docs-serve command to makefile
+  ([`9430934`](https://github.com/dimanu-py/instant-python/commit/943093498f168f49cc8b2593ea17911321f2e012))
+
+- Improve messages of make command and add build and clean commands
+  ([`6a0e428`](https://github.com/dimanu-py/instant-python/commit/6a0e4285d3bb43f9e88dad32fd2f93732ab271c8))
+
+- Remove commitizen config as is not longer needed
+  ([`0ed6a8b`](https://github.com/dimanu-py/instant-python/commit/0ed6a8bd50c6ebf30b71e4734fd3e4a81123b280))
+
 ## 0.8.1 (2025-07-01)
 
 ### 🐛 Bug Fixes
@@ -558,7 +608,6 @@
 - **project-generator**: delegate template management to TemplateManager
 - **cli**: call BasicPrompter and ProjectGenerator inside cli app
 
-
 ### ✨ Features
 
 - **project-generator**: create new custom function to generate import path in templates
@@ -657,4 +706,3 @@
 - **prompter**: create class to encapsulate user answers
 - **prompter**: create basic class that asks project requirements to user
 - **cli**: create basic typer application with no implementation
-

instant_python-0.8.2/CITATION.cff

@@ -0,0 +1,21 @@
+cff-version: 1.2.0
+title: Instant Python
+message: If you use this software, please cite it using the metadata below.
+type: software
+authors:
+  - given-names: Diego
+    family-names: Martínez
+repository-code: https://github.com/dimanu-py/instant-python/
+url: https://pypi.org/project/instant-python/
+abstract: >
+    Instant Python is a command-line tool that generates the base structure of a Python project
+    within seconds.
+    It helps you quickly set up a new Python project with a specific structure, including
+    configuration files, directories, dependencies management, initial code files and much more.
+keywords:
+  - python
+  - boilerplate
+  - project-generator
+  - code-generator
+  - cli
+license: Apache-2.0