python-template-project 0.1.0__tar.gz

python_template_project-0.1.0/.github/FUNDING.yml

@@ -0,0 +1,12 @@
+# These are supported funding model platforms
+
+github: [pamagister]
+patreon: # Replace with a single Patreon username
+open_collective: # Replace with a single Open Collective username
+ko_fi: # Replace with a single Ko-fi username
+tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
+community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
+liberapay: # Replace with a single Liberapay username
+issuehunt: # Replace with a single IssueHunt username
+otechie: # Replace with a single Otechie username
+custom: ["https://www.paypal.me/PaulDD"]

python_template_project-0.1.0/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,31 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: bug, help wanted
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. iOS]
+ - Version [e.g. 22]
+
+**Additional context**
+Add any other context about the problem here.

python_template_project-0.1.0/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: enhancement, question
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

python_template_project-0.1.0/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,15 @@
+### Summary :memo:
+_Write an overview about it._
+
+### Details
+_Describe more what you did on changes._
+1. (...)
+2. (...)
+
+### Bugfixes :bug: (delete if dind't have any)
+-
+
+### Checks
+- [ ] Closed #798
+- [ ] Tested Changes
+- [ ] Stakeholder Approval

python_template_project-0.1.0/.github/actions/setup-environment/action.yml

@@ -0,0 +1,31 @@
+name: Setup Environment
+
+description: Setup uv environment
+
+inputs:
+  python-version:
+    description: 'Python version to use'
+    required: true
+    default: '3.11'
+
+runs:
+  using: "composite"
+  steps:
+    - name: Install uv
+      uses: astral-sh/setup-uv@v3
+      with:
+        version: "latest"
+
+    - name: Create virtual environment
+      run: uv venv .venv --python ${{ inputs.python-version }}
+      shell: bash
+
+    - name: Activate virtual environment
+      run: echo "VIRTUAL_ENV=.venv" >> $GITHUB_ENV
+      shell: bash
+
+    - name: Install dependencies
+      run: |
+        uv pip install -e .
+        uv pip install -e ".[dev]"
+      shell: bash

python_template_project-0.1.0/.github/dependabot.yml

@@ -0,0 +1,6 @@
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"

python_template_project-0.1.0/.github/init.sh

@@ -0,0 +1,68 @@
+#!/usr/bin/env bash
+overwrite_template_dir=0
+
+while getopts t:o flag
+do
+    case "${flag}" in
+        t) template=${OPTARG};;
+        o) overwrite_template_dir=1;;
+    esac
+done
+
+if [ -z "${template}" ]; then
+    echo "Available templates: flask"
+    read -p "Enter template name: " template
+fi
+
+repo_urlname=$(basename -s .git `git config --get remote.origin.url`)
+repo_name=$(basename -s .git `git config --get remote.origin.url` | tr '-' '_' | tr '[:upper:]' '[:lower:]')
+repo_owner=$(git config --get remote.origin.url | awk -F ':' '{print $2}' | awk -F '/' '{print $1}')
+echo "Repo name: ${repo_name}"
+echo "Repo owner: ${repo_owner}"
+echo "Repo urlname: ${repo_urlname}"
+
+if [ -f ".github/workflows/rename_project.yml" ]; then
+    .github/rename_project.sh -a "${repo_owner}" -n "${repo_name}" -u "${repo_urlname}" -d "Awesome ${repo_name} created by ${repo_owner}"
+fi
+
+function download_template {
+    rm -rf "${template_dir}"
+    mkdir -p .github/templates
+    git clone "${template_url}" "${template_dir}"
+}
+
+echo "Using template:${template}"
+template_url="https://github.com/rochacbruno/${template}-project-template"
+template_dir=".github/templates/${template}"
+if [ -d "${template_dir}" ]; then
+    # Template directory already exists
+    if [ "${overwrite_template_dir}" -eq 1 ]; then
+        # user passed -o flag, delete and re-download
+        echo "Overwriting ${template_dir}"
+        download_template
+    else
+        # Ask user if they want to overwrite
+        echo "Directory ${template_dir} already exists."
+        read -p "Do you want to overwrite it? [y/N] " -n 1 -r
+        echo 
+        if [[ $REPLY =~ ^[Yy]$ ]]; then
+            echo "Overwriting ${template_dir}"
+            download_template
+        else
+            # User decided not to overwrite
+            echo "Using existing ${template_dir}"
+        fi
+    fi
+else
+    # Template directory does not exist, download it
+    echo "Downloading ${template_url}"
+    download_template
+fi
+
+echo "Applying ${template} template to this project"}
+./.github/templates/${template}/apply.sh -a "${repo_owner}" -n "${repo_name}" -u "${repo_urlname}" -d "Awesome ${repo_name} created by ${repo_owner}"
+
+# echo "Removing temporary template files"
+# rm -rf .github/templates/${template}
+
+echo "Done! review, commit and push the changes"

python_template_project-0.1.0/.github/release_message.sh

@@ -0,0 +1,3 @@
+#!/usr/bin/env bash
+previous_tag=$(git tag --sort=-creatordate | sed -n 2p)
+git shortlog "${previous_tag}.." | sed 's/^./    &/'

python_template_project-0.1.0/.github/rename_project.sh

@@ -0,0 +1,36 @@
+#!/usr/bin/env bash
+while getopts a:n:u:d: flag
+do
+    case "${flag}" in
+        a) author=${OPTARG};;
+        n) name=${OPTARG};;
+        u) urlname=${OPTARG};;
+        d) description=${OPTARG};;
+    esac
+done
+
+echo "Author: $author";
+echo "Project Name: $name";
+echo "Project URL name: $urlname";
+echo "Description: $description";
+
+echo "Renaming project..."
+
+original_author="pamagister"
+original_name="python-template-project"
+original_urlname="python-template-project"
+original_description="Awesome python-template-project created by pamagister"
+# for filename in $(find . -name "*.*") 
+for filename in $(git ls-files) 
+do
+    sed -i "s/$original_author/$author/g" $filename
+    sed -i "s/$original_name/$name/g" $filename
+    sed -i "s/$original_urlname/$urlname/g" $filename
+    sed -i "s/$original_description/$description/g" $filename
+    echo "Renamed $filename"
+done
+
+mv python-template-project $name
+
+# This command runs only once on GHA!
+rm -rf .github/template.yml

python_template_project-0.1.0/.github/workflows/build-macos.yml

@@ -0,0 +1,93 @@
+name: Build macOS App
+
+on:
+  push:
+    tags:
+      - '*'  # Triggers for tags like 0.1 or v0.1.3
+  workflow_dispatch:  # Allows manual triggering
+
+jobs:
+  build:
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: [ 3.11 ]
+        os: [ macos-latest ]
+    runs-on: ${{ matrix.os }}
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.11'
+
+      - name: Setup Environment # Composite Action
+        uses: ./.github/actions/setup-environment
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Build Unified Executable and App Bundle with PyInstaller
+        run: |
+          echo "Building unified CLI/GUI application as executable"
+          uv run pyinstaller --onefile src/main.py --name python-template-project --add-data "config.yaml:." --hidden-import python_template_project.cli.cli --hidden-import python_template_project.gui.gui
+          
+          echo "Building unified CLI/GUI application as .app bundle"
+          # --windowed is important to hide the console for GUI mode
+          # The name "Python Template Project" becomes the name of the .app
+          uv run pyinstaller --windowed --name "Python Template Project" src/main.py --add-data "config.yaml:." --hidden-import python_template_project.cli.cli --hidden-import python_template_project.gui.gui
+
+      - name: Prepare ZIP file for release
+        run: |
+          mkdir release
+          echo "Copy the CLI/GUI executable"
+          cp dist/python-template-project release/
+          echo "Copy the .app bundle (directory) recursively"
+          cp -R "dist/Python Template Project.app" release/
+          echo "Copy configuration and documentation"
+          cp config.yaml release/
+          cp README.md release/
+          echo "Create usage instructions"
+          cat > release/USAGE.txt << 'EOF'
+          # Python Template Project - macOS Distribution
+          
+          This package contains:
+          
+          1. **python-template-project** (Terminal executable)
+             - Run from Terminal for CLI interface
+             - Double-click will open Terminal and show menu
+          
+          2. **Python Template Project.app** (macOS App Bundle)
+             - Double-click to launch GUI interface
+             - Can also be launched from Terminal: open "Python Template Project.app"
+          
+          ## Usage Examples:
+          
+          ### Command Line:
+          ```bash
+          # Interactive mode (shows CLI/GUI selection)
+          ./python-template-project
+          
+          # Direct CLI mode with arguments
+          ./python-template-project --help
+          ./python-template-project [your-cli-args]
+          ```
+          
+          ### GUI Mode:
+          - Double-click "Python Template Project.app"
+          - Or run: open "Python Template Project.app"
+          
+          EOF
+          echo "Create the ZIP archive from the contents of the release folder"
+          cd release
+          zip -r ../package-macOS.zip .
+
+      - name: Upload ZIP to GitHub Release
+        uses: softprops/action-gh-release@v2
+        if: startsWith(github.ref, 'refs/tags/')
+        with:
+          files: package-macOS.zip
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

python_template_project-0.1.0/.github/workflows/build.yml

@@ -0,0 +1,52 @@
+name: Build Windows EXE
+
+on:
+  push:
+    tags:
+      - '*'  # Triggers for tags like 0.1 or v0.1.3
+  workflow_dispatch:  # Allows manual triggering
+
+jobs:
+  build:
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: [ 3.11 ]
+        os: [ windows-latest ]
+    runs-on: ${{ matrix.os }}
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.11'
+
+      - name: Setup Environment # Composite Action
+        uses: ./.github/actions/setup-environment
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Build Unified EXE with PyInstaller
+        run: |
+          echo "Building unified CLI/GUI application"
+          uv run pyinstaller --onefile src/main.py --name python-template-project --add-data "config.yaml;." --hidden-import python_template_project.cli.cli --hidden-import python_template_project.gui.gui
+
+      - name: Prepare ZIP file for release
+        run: |
+          mkdir release
+          copy dist\python-template-project.exe release\
+          copy config.yaml release\
+          copy README.md release\
+          echo "  - Double-click to start GUI" >> release\USAGE.txt
+          echo "  - Run from command line for CLI options" >> release\USAGE.txt
+          powershell Compress-Archive -Path release\* -DestinationPath installer-win.zip
+
+      - name: Upload ZIP to GitHub Release
+        uses: softprops/action-gh-release@v2
+        if: startsWith(github.ref, 'refs/tags/')
+        with:
+          files: installer-win.zip
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

python_template_project-0.1.0/.github/workflows/main.yml

@@ -0,0 +1,83 @@
+# This is a basic workflow to help you get started with Actions
+
+name: CI
+
+# Controls when the workflow will run
+on:
+  # Triggers the workflow on push or pull request events but only for the main branch
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+jobs:
+  linter:
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: [ 3.11 ]
+        os: [ubuntu-latest]
+    runs-on: ${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Setup Environment # Composite Action
+        uses: ./.github/actions/setup-environment
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Run linter
+        run: make lint
+
+  tests_win:
+    needs: linter
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: [ 3.11 ]
+        os: [windows-latest]
+    runs-on: ${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Setup Environment # Composite Action
+        uses: ./.github/actions/setup-environment
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: run tests
+        run: uv run pytest -s -vvvv -l --tb=long tests
+
+  tests_linux_macos:
+    needs: tests_win
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: [ 3.11 ]
+        os: [ ubuntu-latest, macos-latest ]
+    runs-on: ${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Setup Environment # Composite Action
+        uses: ./.github/actions/setup-environment
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Run tests
+        run: make test
+
+      - name: "Upload coverage to Codecov"
+        uses: codecov/codecov-action@v5

python_template_project-0.1.0/.github/workflows/release.yml

@@ -0,0 +1,58 @@
+name: Upload Python Package
+permissions:
+  contents: write
+
+# if you get a Permission denied error on executing the sh file, you have to execute:
+# git update-index --chmod=+x ./.github/release_message.sh
+
+on:
+  push:
+    # Sequence of patterns matched against refs/tags
+    tags:
+      - '*' # Push events to matching v*, i.e. v1.0, v20.15.10
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+jobs:
+  release:
+    name: Create Release
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          # by default, it uses a depth of 1
+          # this fetches all history so that we can read each commit
+          fetch-depth: 0
+      - name: Generate Changelog
+        run: .github/release_message.sh > release_message.md
+      - name: Release
+        uses: softprops/action-gh-release@v2
+        with:
+          body_path: release_message.md
+
+  deploy:
+    needs: release
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python
+      uses: actions/setup-python@v4
+      with:
+        # Use a specific Python version, e.g., 3.11, consistent with your build
+        python-version: '3.11'
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        # install build for modern packaging, and twine
+        pip install build twine
+    - name: Build and publish
+      env:
+        TWINE_USERNAME: __token__
+        TWINE_PASSWORD: ${{ secrets.PYPI_API_TOKEN }}
+      run: |
+        # Use 'python -m build' for modern packaging
+        python -m build
+        twine upload dist/*

python_template_project-0.1.0/.github/workflows/update-readme.yml

@@ -0,0 +1,28 @@
+name: Sync README with docs/index.md
+
+on:
+  push:
+    paths:
+      - "docs/index.md"
+    branches: [ main ]
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+jobs:
+  sync:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+      - name: Update README.md
+        run: python scripts/update_readme.py
+      - name: Commit changes
+        run: |
+          git config user.name "github-actions"
+          git config user.email "github-actions@github.com"
+          git add README.md
+          git commit -m "Update README.md from docs/index.md" || echo "No changes"
+          git push