ci: 🎨 Py Sample

.dockerignore

@@ -0,0 +1,10 @@
+# all start with .(dot), including directories and files
+.*
+CHANGELOG.md
+CODE_OF_CONDUCT.md
+compose.yml
+CONTRIBUTING.md
+Dockerfile
+LICENSE*
+README.md
+SECURITY.md

.editorconfig

@@ -0,0 +1,14 @@
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+indent_size = 4
+indent_style = space
+insert_final_newline = true
+max_line_length = 120
+tab_width = 4
+trim_trailing_whitespace = true
+
+[Makefile]
+indent_style = tab

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,44 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: bug
+assignees: ''
+
+---
+
+## Bug description
+
+<!-- A clear and concise description of what the bug is. -->
+
+- Would you like to work on a fix? [y/n]
+
+## To Reproduce
+
+Steps to reproduce the behavior:
+
+1. ...
+2. ...
+3. ...
+4. ...
+
+<!-- Make sure you are able to reproduce the bug in the main branch, too. -->
+
+## Expected behavior
+
+<!-- A clear and concise description of what you expected to happen. -->
+
+## Screenshots
+
+<!-- If applicable, add screenshots to help explain your problem. -->
+
+## Environment
+
+<!-- Please fill the following information. -->
+
+- OS: [e.g. Ubuntu 20.04]
+- example_py version: [e.g. 0.1.0]
+
+## Additional context
+
+<!-- Add any other context about the problem here. -->

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1 @@
+blank_issues_enabled: true

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,28 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: enhancement
+assignees: ''
+
+---
+
+## Motivations
+
+<!--
+If your feature request is related to a problem, please describe it.
+-->
+
+- Would you like to implement this feature? [y/n]
+
+## Solution
+
+<!-- Describe the solution you'd like. -->
+
+## Alternatives
+
+<!-- Describe any alternative solutions or features you've considered. -->
+
+## Additional context
+
+<!-- Add any other context or screenshots about the feature request here. -->

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,9 @@
+<!-- Please explain the changes you made -->
+
+<!--
+Please make sure:
+- you have read the contributing guidelines:
+  https://github.com/x-pt/example-py/blob/main/docs/CONTRIBUTING.md
+- you have updated the changelog (if needed):
+  https://github.com/x-pt/example-py/blob/main/CHANGELOG.md
+-->

.github/dependabot.yml

@@ -0,0 +1,8 @@
+version: 2
+updates:
+    -   package-ecosystem: "github-actions"
+        directory: "/"
+        # Check for updates every Monday
+        schedule:
+            interval: "weekly"
+        open-pull-requests-limit: 10

.github/renovate.json

@@ -0,0 +1,6 @@
+{
+    "$schema": "https://docs.renovatebot.com/renovate-schema.json",
+    "extends": [
+        "config:base"
+    ]
+}

.github/workflows/cd.yml

@@ -0,0 +1,14 @@
+name: CD # Continuous Deployment or Delivery
+
+on:
+    push:
+        # e.g. 1.0.0, v2.0.0, v0.1.0, v0.2.0-alpha, v0.3.0+build-71edf32
+        tags:
+            - '[v]?[0-9]+\.[0-9]+\.[0-9]+.*'
+
+jobs:
+    dd:
+        name: Deploy or Delivery
+        runs-on: ubuntu-latest
+        steps:
+            -   uses: actions/checkout@v4

.github/workflows/ci.yml

@@ -0,0 +1,14 @@
+name: CI # Continuous Integration
+
+on:
+    push:
+        branches:
+            - main
+    pull_request:
+    workflow_dispatch:
+
+jobs:
+    build:
+        runs-on: ubuntu-latest
+        steps:
+            -   uses: actions/checkout@v4

.github/workflows/docker.yml

@@ -0,0 +1,54 @@
+name: Build and Push Docker Image
+
+on:
+    push:
+        tags:
+            - '^v[0-9]+\.[0-9]+\.[0-9]+.*$'
+
+jobs:
+    docker:
+        runs-on: ubuntu-latest
+        steps:
+            -
+                name: Checkout
+                uses: actions/checkout@v4
+            -
+                name: Acquire tag name
+                run: echo "RELEASE_VERSION=${GITHUB_REF_NAME#refs/*/}" >> $GITHUB_ENV
+            -
+                name: Set up QEMU
+                uses: docker/setup-qemu-action@v3
+            -
+                name: Set up Docker Buildx
+                uses: docker/setup-buildx-action@v3
+            -
+                name: Login to GitHub Container Registry
+                uses: docker/login-action@v3
+                with:
+                    registry: ghcr.io
+                    username: ${{ github.repository_owner }}
+                    password: ${{ secrets.GITHUB_TOKEN }}
+            -
+                name: Build and Export to Docker
+                uses: docker/build-push-action@v6
+                with:
+                    context: .
+                    load: true
+                    tags: |
+                        ghcr.io/x-pt/example-py:latest
+                        ghcr.io/x-pt/example-py:${GITHUB_REF_NAME:1}
+            -
+                name: Test it before Push
+                run: |
+                    docker run --rm ghcr.io/x-pt/example-py:latest
+                    docker run --rm ghcr.io/x-pt/example-py:${GITHUB_REF_NAME:1}
+            -
+                name: Build and Push
+                uses: docker/build-push-action@v6
+                with:
+                    context: .
+                    platforms: linux/amd64,linux/arm64
+                    push: true
+                    tags: |
+                        ghcr.io/x-pt/example-py:latest
+                        ghcr.io/x-pt/example-py:${GITHUB_REF_NAME:1}

.gitignore

@@ -0,0 +1,145 @@
+### Custom
+.idea
+.vscode
+.DS_Store
+
+### Python template
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+

.pre-commit-config.yaml

@@ -0,0 +1,23 @@
+repos:
+    -   repo: https://github.com/pre-commit/pre-commit-hooks
+        rev: v4.6.0
+        hooks:
+            -   id: check-merge-conflict
+            -   id: check-toml
+            -   id: check-yaml
+            -   id: end-of-file-fixer
+            -   id: mixed-line-ending
+                args: [ --fix=lf ]
+            -   id: trailing-whitespace
+    -   repo: https://github.com/commitizen-tools/commitizen
+        rev: v3.29.0
+        hooks:
+            -   id: commitizen
+    -   repo: https://github.com/astral-sh/ruff-pre-commit
+        rev: v0.6.1
+        hooks:
+            # Run the linter.
+            -   id: ruff
+                args: [ --fix ]
+            # Run the formatter.
+            -   id: ruff-format