Add template for FastAPI applications

.github/workflows/publish_binaries.yml

@@ -37,7 +37,7 @@ jobs:
       - name: Add target
         run: rustup target add ${{ matrix.target }}
       - name: Build
-        run: cargo build --release --locked --target ${{ matrix.target }}
+        run: cargo build --release --locked --target ${{ matrix.target }} --all-features
       - name: Upload binaries to release
         uses: svenstaro/upload-release-action@v2
         with:
@@ -70,7 +70,7 @@ jobs:
       - name: Create package
         id: create-deb
         run: |
-          cargo deb --deb-revision=""  # --deb-revision="" removes the -1 post tag
+          cargo deb --locked --all-features --deb-revision=""  # --deb-revision="" removes the -1 post tag
           cd target/debian
           echo "DEB_FILE=$(find python-project-generator*_*.deb)" >> "$GITHUB_OUTPUT"
       - name: Upload deb package to release

.github/workflows/testing.yml

@@ -18,21 +18,36 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v5
-      - name: Install Rust
-        run: |
-          curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y
+      - name: install Rust
+        uses: dtolnay/rust-toolchain@stable
+        with:
+          components: clippy
       - name: Cache dependencies
         uses: Swatinem/[email protected]
       - name: Run cargo clippy
         run: cargo clippy --all-targets -- --deny warnings
+  clippy-fastapi:
+    name: clippy-fastapi
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+      - name: install Rust
+        uses: dtolnay/rust-toolchain@stable
+        with:
+          components: clippy
+      - name: Cache dependencies
+        uses: Swatinem/[email protected]
+      - name: Run cargo clippy
+        run: cargo clippy --all-targets -F fastapi -- --deny warnings
   fmt:
     name: Rustfmt
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v5
-      - name: Install Rust
-        run: |
-          curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y
+      - name: install Rust
+        with:
+          components: rustfmt
+        uses: dtolnay/rust-toolchain@stable
       - name: Cache dependencies
         uses: Swatinem/[email protected]
       - name: Run cargo fmt
@@ -42,17 +57,31 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        os: [ubuntu-latest, macos-latest, windows-latest]
+        os: [ubuntu-latest, windows-latest]
     runs-on: ${{ matrix.os }}
     steps:
       - uses: actions/checkout@v5
-      - name: Install Rust
-        run: |
-          curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y
+      - name: install Rust
+        uses: dtolnay/rust-toolchain@stable
       - name: Cache dependencies
         uses: Swatinem/[email protected]
       - name: Run cargo test
         run: cargo test --locked
+  test-fastapi:
+    name: test-fastapi
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, windows-latest]
+    runs-on: ${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@v5
+      - name: install Rust
+        uses: dtolnay/rust-toolchain@stable
+      - name: Cache dependencies
+        uses: Swatinem/[email protected]
+      - name: Run cargo test
+        run: cargo test --locked -F fastapi
   uv-linting:
     strategy:
       fail-fast: false
@@ -61,12 +90,11 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v5
-      - name: Install Rust
-        run: |
-          curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y
+      - name: install Rust
+        uses: dtolnay/rust-toolchain@stable
       - name: Cache Rust dependencies
         uses: Swatinem/[email protected]
-      - name: Install uv on Linux and Mac
+      - name: Install uv on Linux
         if: runner.os != 'Windows'
         run: curl -LsSf https://astral.sh/uv/install.sh | sh
       - name: Install uv on Windows
@@ -99,16 +127,15 @@ jobs:
       fail-fast: false
       matrix:
         project_type: ["application", "lib"]
-        os: [ubuntu-latest, macos-latest, windows-latest]
+        os: [ubuntu-latest, windows-latest]
     runs-on: ${{ matrix.os }}
     steps:
       - uses: actions/checkout@v5
-      - name: Install Rust
-        run: |
-          curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y
+      - name: install Rust
+        uses: dtolnay/rust-toolchain@stable
       - name: Cache Rust dependencies
         uses: Swatinem/[email protected]
-      - name: Install uv on Linux and Mac
+      - name: Install uv on Linux
         if: runner.os != 'Windows'
         run: curl -LsSf https://astral.sh/uv/install.sh | sh
       - name: Install uv on Windows
@@ -146,9 +173,8 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v5
-      - name: Install Rust
-        run: |
-          curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y
+      - name: install Rust
+        uses: dtolnay/rust-toolchain@stable
       - name: Cache Rust dependencies
         uses: Swatinem/[email protected]
       - name: Install Poetry
@@ -182,13 +208,12 @@ jobs:
       fail-fast: false
       matrix:
         project_type: ["application", "lib"]
-        os: [ubuntu-latest, macos-latest, windows-latest]
+        os: [ubuntu-latest, windows-latest]
     runs-on: ${{ matrix.os }}
     steps:
       - uses: actions/checkout@v5
-      - name: Install Rust
-        run: |
-          curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y
+      - name: install Rust
+        uses: dtolnay/rust-toolchain@stable
       - name: Cache Rust dependencies
         uses: Swatinem/[email protected]
       - name: Install Poetry
@@ -228,12 +253,13 @@ jobs:
       - uses: actions/checkout@v5
       - name: Install Just
         uses: taiki-e/install-action@just
-      - name: Install Rust
-        run: |
-          curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y
+      - name: install Rust
+        uses: dtolnay/rust-toolchain@stable
+        with:
+          components: clippy, rustfmt
       - name: Cache Rust dependencies
         uses: Swatinem/[email protected]
-      - name: Install uv on Linux and Mac
+      - name: Install uv on Linux
         if: runner.os != 'Windows'
         run: curl -LsSf https://astral.sh/uv/install.sh | sh
       - name: Install uv on Windows
@@ -273,16 +299,15 @@ jobs:
       fail-fast: false
       matrix:
         project_type: ["application", "lib"]
-        os: [ubuntu-latest, macos-latest, windows-latest]
+        os: [ubuntu-latest, windows-latest]
     runs-on: ${{ matrix.os }}
     steps:
       - uses: actions/checkout@v5
-      - name: Install Rust
-        run: |
-          curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y
+      - name: install Rust
+        uses: dtolnay/rust-toolchain@stable
       - name: Cache Rust dependencies
         uses: Swatinem/[email protected]
-      - name: Install uv on Linux and Mac
+      - name: Install uv on Linux
         if: runner.os != 'Windows'
         run: curl -LsSf https://astral.sh/uv/install.sh | sh
       - name: Install uv on Windows
@@ -320,9 +345,8 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v5
-      - name: Install Rust
-        run: |
-          curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y
+      - name: install Rust
+        uses: dtolnay/rust-toolchain@stable
       - name: Cache Rust dependencies
         uses: Swatinem/[email protected]
       - name: Set up Python
@@ -353,13 +377,12 @@ jobs:
       fail-fast: false
       matrix:
         project_type: ["application", "lib"]
-        os: [ubuntu-latest, macos-latest, windows-latest]
+        os: [ubuntu-latest, windows-latest]
     runs-on: ${{ matrix.os }}
     steps:
       - uses: actions/checkout@v5
-      - name: Install Rust
-        run: |
-          curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y
+      - name: install Rust
+        uses: dtolnay/rust-toolchain@stable
       - name: Cache Rust dependencies
         uses: Swatinem/[email protected]
       - name: Set up Python
@@ -394,9 +417,8 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v5
-      - name: Install Rust
-        run: |
-          curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y
+      - name: install Rust
+        uses: dtolnay/rust-toolchain@stable
       - name: Cache Rust dependencies
         uses: Swatinem/[email protected]
       - name: Build package
@@ -426,13 +448,12 @@ jobs:
       fail-fast: false
       matrix:
         project_type: ["application", "lib"]
-        os: [ubuntu-latest, macos-latest, windows-latest]
+        os: [ubuntu-latest, windows-latest]
     runs-on: ${{ matrix.os }}
     steps:
       - uses: actions/checkout@v5
-      - name: Install Rust
-        run: |
-          curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y
+      - name: install Rust
+        uses: dtolnay/rust-toolchain@stable
       - name: Cache Rust dependencies
         uses: Swatinem/[email protected]
       - name: Build package

.github/workflows/testing_fastapi.yml

@@ -0,0 +1,111 @@
+name: Testing FastAPI
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+env:
+  CARGO_TERM_COLOR: always
+  RUST_BACKTRACE: 1
+  RUSTFLAGS: "-D warnings"
+  WORKING_DIR: "my-project"
+  MIN_PYTHON_VERSION: "3.11"
+  SECRET_KEY: someKey
+  FIRST_SUPERUSER_EMAIL: [email protected]
+  FIRST_SUPERUSER_PASSWORD: My_password1
+  FIRST_SUPERUSER_NAME: "Wade Watts"
+  POSTGRES_HOST: 127.0.0.1
+  POSTGRES_PORT: 5432
+  POSTGRES_USER: postgres
+  POSTGRES_PASSWORD: test_password
+  POSTGRES_DB: test_db
+  VALKEY_HOST: 127.0.0.1
+  VALKEY_PASSWORD: test_password
+  STACK_NAME: test-stack
+  DOMAIN: 127.0.0.1
+  PRODUCTION_MODE: false
+  DATABASE_URL: postgresql://postgres:[email protected]:5432/test_db
+jobs:
+  test-uv-fastapi-project:
+    name: test-fastapi-uv-setup-fastapi
+    strategy:
+      fail-fast: false
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+      - name: install Rust
+        uses: dtolnay/rust-toolchain@stable
+      - name: Cache dependencies
+        uses: Swatinem/[email protected]
+      - name: Install sqlx-cli
+        run: cargo install sqlx-cli --no-default-features -F native-tls -F postgres
+      - name: Install uv
+        run: curl -LsSf https://astral.sh/uv/install.sh | sh
+      - name: Set up Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: ${{ env.MIN_PYTHON_VERSION }}
+      - name: Build package
+        run: cargo build --release -F fastapi
+      - name: Run creation
+        run: ./scripts/ci_run_fastapi.sh "fastapi" 1
+        shell: bash
+      - name: Install Dependencies
+        working-directory: ${{ env.WORKING_DIR }}
+        run: |
+          uv lock
+          uv sync --frozen
+      - name: Pre-commit check
+        working-directory: ${{ env.WORKING_DIR }}
+        run: |
+          uv run pre-commit install
+          git add .
+          uv run pre-commit run --all-files
+      - name: make .env
+        working-directory: ${{ env.WORKING_DIR }}
+        run: touch .env
+      - name: Build and start Docker containers
+        working-directory: ${{ env.WORKING_DIR }}
+        run: docker compose up -d
+      - name: Test with pytest
+        working-directory: ${{ env.WORKING_DIR }}
+        run: uv run pytest -n auto
+  test-uv-non-fastapi-project:
+    name: test-fastapi-uv-setup-non-fastapi
+    strategy:
+      fail-fast: false
+      matrix:
+        project_type: ["application", "lib"]
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+      - name: install Rust
+        uses: dtolnay/rust-toolchain@stable
+      - name: Cache dependencies
+        uses: Swatinem/[email protected]
+      - name: Install uv
+        run: curl -LsSf https://astral.sh/uv/install.sh | sh
+      - name: Set up Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: ${{ env.MIN_PYTHON_VERSION }}
+      - name: Build package
+        run: cargo build --release -F fastapi
+      - name: Run creation
+        run: ./scripts/ci_run_fastapi.sh ${{ matrix.project_type }} 1
+        shell: bash
+      - name: Install Dependencies
+        working-directory: ${{ env.WORKING_DIR }}
+        run: |
+          uv lock
+          uv sync --frozen
+      - name: Pre-commit check
+        working-directory: ${{ env.WORKING_DIR }}
+        run: |
+          uv run pre-commit install
+          git add .
+          uv run pre-commit run --all-files
+      - name: Test with pytest
+        working-directory: ${{ env.WORKING_DIR }}
+        if: matrix.project_type == 'application'
+        run: uv run pytest

Cargo.toml

@@ -16,6 +16,9 @@ license = "MIT"
 name = "python-project"
 path = "src/main.rs"
 
+[features]
+fastapi = []
+
 [dependencies]
 anyhow = "1.0.100"
 clap = { version = "4.5.48", features = ["color", "suggestions", "derive"] }