chore: update GitHub Actions versions and remove broken Safety checks, add docs structure

Author: Magic-Man-us

.github/workflows/ci.yml

@@ -38,10 +38,10 @@ jobs:
 
     steps:
       - name: Checkout
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
 
       - name: Install uv
-        uses: astral-sh/setup-uv@v4
+        uses: astral-sh/setup-uv@v7
         with:
           enable-cache: true
 
@@ -72,19 +72,19 @@ jobs:
           fi
 
       - name: Upload coverage.xml
-        uses: actions/upload-artifact@v4
+        uses: actions/upload-artifact@v5
         with:
           name: coverage-${{ matrix.python-version }}
           path: coverage.xml
 
       - name: Upload coverage HTML
-        uses: actions/upload-artifact@v4
+        uses: actions/upload-artifact@v5
         with:
           name: coverage-html-${{ matrix.python-version }}
           path: htmlcov
 
   security:
-    name: Security Scan (Bandit + Safety)
+    name: Security Scan (Bandit)
     runs-on: ubuntu-latest
     needs: test
     permissions:
@@ -95,10 +95,10 @@ jobs:
 
     steps:
       - name: Checkout
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
 
       - name: Install uv
-        uses: astral-sh/setup-uv@v4
+        uses: astral-sh/setup-uv@v7
         with:
           enable-cache: true
 
@@ -113,24 +113,16 @@ jobs:
           uv run bandit -r python_project_deployment/ -f json -o bandit-report.json || true
           uv run bandit -r python_project_deployment/ -f txt
 
-      - name: Run Safety (JSON)
-        run: uv run safety check --json > safety-report.json || true
-
       - name: Apply Bandit threshold
         run: uv run python scripts/security_bandit_check.py
         continue-on-error: true
 
-      - name: Fail on Safety vulnerabilities
-        run: uv run python scripts/security_safety_check.py
-
       - name: Upload security reports
         if: always()
-        uses: actions/upload-artifact@v4
+        uses: actions/upload-artifact@v5
         with:
           name: security-reports
-          path: |
-            bandit-report.json
-            safety-report.json
+          path: bandit-report.json
 
   docs:
     name: Build Documentation
@@ -141,10 +133,10 @@ jobs:
 
     steps:
       - name: Checkout
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
 
       - name: Install uv
-        uses: astral-sh/setup-uv@v4
+        uses: astral-sh/setup-uv@v7
         with:
           enable-cache: true
 
@@ -158,7 +150,7 @@ jobs:
         run: uv run sphinx-build -b html docs docs/_build/html
 
       - name: Upload documentation artifacts
-        uses: actions/upload-artifact@v4
+        uses: actions/upload-artifact@v5
         with:
           name: documentation
           path: docs/_build/html

docs/conf.py

@@ -0,0 +1,31 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+
+project = "Python Project Deployment"
+copyright = "2025, Python Project Deployment Contributors"
+author = "Python Project Deployment Contributors"
+release = "0.1.0"
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = [
+    "sphinx.ext.autodoc",
+    "sphinx.ext.napoleon",
+    "sphinx.ext.viewcode",
+]
+
+templates_path = ["_templates"]
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
+
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+html_theme = "sphinx_rtd_theme"
+html_static_path = ["_static"]

docs/index.rst

@@ -0,0 +1,61 @@
+Python Project Deployment Documentation
+========================================
+
+A modern scaffolding tool for creating new Python packages with best practices built-in.
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   installation
+   usage
+   api
+
+Installation
+============
+
+Install using uv (preferred):
+
+.. code-block:: bash
+
+   uv venv
+   uv sync --all-extras
+
+Quick Start
+===========
+
+Create a new Python package:
+
+.. code-block:: bash
+
+   scaffold-python my_awesome_package /path/to/parent/directory
+
+API Reference
+=============
+
+.. automodule:: python_project_deployment
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. automodule:: python_project_deployment.cli
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. automodule:: python_project_deployment.models
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. automodule:: python_project_deployment.scaffolder
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

scripts/security_safety_check.py

@@ -10,7 +10,7 @@ def main() -> None:
     """Check safety results for any vulnerabilities."""
     report_path = Path("safety-report.json")
     if not report_path.exists():
-        print("No safety-report.json found, skipping.")
+        print("✅ No safety-report.json found, skipping.")
         return
 
     with report_path.open() as f: