fix: best practice refactor

fix: best practice refactor

Author: milsman2

.github/workflows/pylint.yaml

@@ -11,12 +11,12 @@ jobs:
     permissions:
       contents: read
     env:
-      UV_VERSION: '0.9.27'
+      UV_VERSION: '0.9.28'
       PYTHON_VERSION: '3.13'
 
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v4
+        uses: actions/checkout@v6
 
       - name: Restore global uv cache
         id: cache-restore

.github/workflows/pytest.yaml

@@ -11,11 +11,11 @@ jobs:
     permissions:
       contents: read
     env:
-      UV_VERSION: '0.9.27'
+      UV_VERSION: '0.9.28'
       PYTHON_VERSION: '3.13'
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v4
+        uses: actions/checkout@v6
 
       - name: Restore uv caches
         id: cache-restore

.github/workflows/release.yaml

@@ -0,0 +1,78 @@
+name: UV - Release
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  Semantic-Release:
+    runs-on: ubuntu-latest
+    outputs:
+      tag: ${{ steps.release.outputs.tag }}
+    concurrency:
+      group: ${{ github.workflow }}-release-${{ github.ref_name }}
+      cancel-in-progress: false
+    permissions:
+      contents: write
+    env:
+      dist_artifacts_name: dist
+      dist_artifacts_dir: dist
+      lock_file_artifact: uv.lock
+      UV_VERSION: '0.9.28'
+      PYTHON_VERSION: '3.13'
+      GITHUB_ACTIONS_AUTHOR_NAME: github-actions
+      GITHUB_ACTIONS_AUTHOR_EMAIL: actions@users.noreply.github.com
+    steps:
+      - name: Setup | Checkout Repository on Release Branch
+        uses: actions/checkout@v6
+        with:
+          ref: ${{ github.ref_name }}
+
+      - name: Setup | Force release branch to be at workflow sha
+        run: |
+          git reset --hard ${{ github.sha }}
+
+      - name: Restore global uv cache
+        id: cache-restore
+        uses: actions/cache/restore@v4
+        with:
+          path: |
+            ~/.cache/uv
+            ~/.local/share/uv
+            .venv
+          key: uv-main-${{ env.UV_VERSION }}-${{ env.PYTHON_VERSION }}-${{ hashFiles('pyproject.toml', 'uv.lock') }}
+          restore-keys: |
+            uv-main-
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v7
+        with:
+          version: ${{ env.UV_VERSION }}
+          python-version: ${{ env.PYTHON_VERSION }}
+          enable-cache: false
+
+      - name: Action | Semantic Version Release
+        id: release
+        uses: python-semantic-release/python-semantic-release@v10.5.3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          git_committer_name: 'github-actions'
+          git_committer_email: 'actions@users.noreply.github.com'
+
+      - name: Publish | Upload to GitHub Release Assets
+        uses: python-semantic-release/publish-action@v10.5.3
+        if: steps.release.outputs.released == 'true'
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          tag: ${{ steps.release.outputs.tag }}
+
+      - name: Save uv caches
+        if: steps.cache-restore.outputs.cache-hit != 'true'
+        uses: actions/cache/save@v4
+        with:
+          path: |
+            ~/.cache/uv
+            ~/.local/share/uv
+            .venv
+          key: uv-main-${{ env.UV_VERSION }}-${{ env.PYTHON_VERSION }}-${{ hashFiles('pyproject.toml', 'uv.lock') }}

pyproject.toml

@@ -1,10 +1,5 @@
-[tool.coverage.run]
-source = ["src"]
-
-[tool.coverage.report]
-omit = ["tests/*"]
 [project]
-name = "python-app-template"
+name = "sample_python_app"
 version = "0.1.0"
 description = "Add your description here"
 readme = "README.md"
@@ -23,7 +18,14 @@ dependencies = [
 ]
 
 [project.optional-dependencies]
-build = ["uv ~= 0.9.27"]
+build = ["uv >= 0.9.28"]
+
+[build-system]
+requires = ["uv_build >= 0.9.28, < 0.10.0"]
+build-backend = "uv_build"
+
+[project.scripts]
+sample-python-app = "sample_python_app.main:run_app"
 
 [tool.semantic_release]
 build_command = """
@@ -32,3 +34,10 @@ build_command = """
     git add uv.lock
     uv build
 """
+version_toml = ["pyproject.toml:project.version"]
+
+[tool.coverage.run]
+source = ["src"]
+
+[tool.coverage.report]
+omit = ["tests/*"]

src/core/__init__.py

@@ -0,0 +1,8 @@
+"""
+Export core modules for use in other modules.
+"""
+
+from sample_python_app.core.config import settings
+from sample_python_app.core.logging import setup_logger
+
+__all__ = ["settings", "setup_logger"]

src/__init__.py src/sample_python_app/__init__.pysrc/__init__.py renamed to src/sample_python_app/__init__.py

@@ -2,14 +2,14 @@
 Main entry point for the python-app-template project.
 """
 
-from src.core import settings, setup_logger
+from sample_python_app.core import settings, setup_logger
 
 
-def main():
+def run_app():
     logger = setup_logger()
     logger.info(f"Starting {settings.APP_NAME}...")
     logger.info("Hello from python-app-template!")
 
 
 if __name__ == "__main__":  # pragma: no cover
-    main()
+    run_app()