feat: Create best-in-class Python package template

This commit introduces a new Python package template with a modern, standardized dependency manager (Poetry), a comprehensive, self-validating quality and linting suite using `pre-commit`, an optimized, secure, multi-stage `Dockerfile`, and a robust, secure, and efficient CI/CD pipeline for GitHub Actions.

The template is designed to be fully self-contained and capable of passing its own `pre-commit` checks with zero errors upon creation.

It also includes a dual-licensing model with the Prosperity Public License for non-commercial use and a commercial license available upon request.

Author: google-labs-jules[bot]

.dockerignore

@@ -10,5 +10,4 @@ README.md
 .gitignore
 LICENSE
 Dockerfile
-poetry.lock
-pyproject.toml
+LICENSING.md

.github/workflows/ci.yml

@@ -24,8 +24,17 @@ jobs:
       - uses: actions/checkout@ff7abcd0c3c05ccf6adc123a8cd1fd4fb30fb493
       - uses: pre-commit/action@1b06ec171f2f6faa71ed760c4042bd969e4f8b43
 
+  lint-docker:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@ff7abcd0c3c05ccf6adc123a8cd1fd4fb30fb493
+      - name: Lint Dockerfile
+        uses: hadolint/hadolint-action@54c9adbab1582136bcea3692aa25b7a70191834f
+        with:
+          dockerfile: Dockerfile
+
   test:
-    needs: lint
+    needs: [lint, lint-docker]
     runs-on: ubuntu-latest
     strategy:
       matrix:

.github/workflows/docker.yml

@@ -21,24 +21,18 @@ jobs:
       - name: Checkout
         uses: actions/checkout@ff7abcd0c3c05ccf6adc123a8cd1fd4fb30fb493
 
-      - name: Log in to the Container registry
-        uses: docker/login-action@28fdb31ff34708d19615a74d67103ddc2ea9725c
-        with:
-          registry: ghcr.io
-          username: ${{ github.actor }}
-          password: ${{ secrets.GITHUB_TOKEN }}
-
       - name: Set up QEMU
         uses: docker/setup-qemu-action@e77e8065d9f7ec6abdd9838668cd7b43924dd64d
 
       - name: Set up Docker Buildx
         uses: docker/setup-buildx-action@1583c0f09d26c58c59d25b0eef29792b7ce99d9a
 
-      - name: Build and push
+      - name: Build image
+        id: build
         uses: docker/build-push-action@9e436ba9f2d7bcd1d038c8e55d039d37896ddc5d
         with:
           context: .
-          push: true
+          load: true
           tags: ghcr.io/${{ github.repository }}:${{ github.sha }}
           cache-from: type=gha
           cache-to: type=gha,mode=max
@@ -52,3 +46,14 @@ jobs:
           ignore-unfixed: true
           vuln-type: 'os,library'
           severity: 'CRITICAL,HIGH'
+
+      - name: Log in to the Container registry
+        if: success()
+        uses: docker/login-action@28fdb31ff34708d19615a74d67103ddc2ea9725c
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+      - name: Push image
+        if: success()
+        run: docker push ghcr.io/${{ github.repository }}:${{ github.sha }}

.pre-commit-config.yaml

@@ -17,7 +17,7 @@ repos:
     rev: v1.10.0
     hooks:
       - id: mypy
-  - repo: https://github.com/hadolint/hadolint
+  - repo: https://github.com/hadolint/hadolint-pre-commit
     rev: v2.12.0
     hooks:
-      - id: hadolint-docker
+      - id: hadolint

LICENSE

@@ -2,7 +2,7 @@
 
 Contributor: CoReason, Inc.
 
-Source Code: $address
+Source Code: https://github.com/coreason-ai/my_python_project
 
 ## Purpose
 

LICENSING.md

@@ -0,0 +1,13 @@
+# Licensing
+
+This project is offered under a dual-license model.
+
+## Non-Commercial Use
+
+For non-commercial use, this project is licensed under the **Prosperity Public License 3.0.0**. This license allows you to use and share this software for non-commercial purposes for free, and provides a thirty-day trial period for commercial purposes. The full text of the license is available in the `LICENSE` file.
+
+## Commercial Use
+
+For any use that falls outside the "Non-Commercial Use" definition or extends beyond the thirty-day trial period for commercial purposes as defined in the Prosperity Public License, a separate commercial license is required.
+
+To obtain a commercial license, please contact CoReason, Inc. at <gowtham.rao@coreason.ai>.

README.md

@@ -27,8 +27,13 @@ This is a best-in-class Python package template.
   ```bash
   poetry run pre-commit run --all-files
   ```
+  **Note:** The first time you run the linter, the `hadolint` hook may take a few minutes to download and install.
 
 * **Run tests:**
   ```bash
   poetry run pytest
   ```
+
+## Licensing
+
+This project is dual-licensed. See `LICENSING.md` for more details.

poetry.lock

@@ -12,6 +12,7 @@ python = "^3.10"
 pytest = "^8.2.2"
 ruff = "^0.5.0"
 mypy = "^1.10.0"
+pre-commit = "^3.7.1"
 
 [build-system]
 requires = ["poetry-core"]