Initial commit

Author: pythoninthegrass

.dockerignore

@@ -0,0 +1,36 @@
+**/__pycache__
+**/.classpath
+**/.dockerignore
+**/.DS_Store
+**/.editorconfig
+**/.env
+**/.git
+**/.github
+**/.gitignore
+**/.project
+**/.settings
+**/.toolstarget
+**/.vs
+**/.vscode
+**/*.*proj.user
+**/*.dbmdl
+**/*.jfm
+**/*.py#
+**/*.py~
+**/*.pyc
+**/azds.yaml
+**/bin
+**/charts
+**/compose*
+**/csv
+**/django
+**/docker-compose*
+**/Dockerfile*
+**/img
+**/node_modules
+**/npm-debug.log
+**/obj
+**/README.md
+**/secrets.dev.yaml
+**/terraform
+**/values.dev.yaml

.editorconfig

@@ -0,0 +1,34 @@
+# EditorConfig is awesome: https://EditorConfig.org
+
+# top-most EditorConfig file
+root = true
+
+# Unix-style newlines and whitespace cleanup
+[*]
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+# Protect whitespace in markdown files
+[*.md]
+trim_trailing_whitespace = false
+
+# general formatting
+[*.{bash,go,sh,zsh,Makefile}]
+indent_style = tab
+indent_size = 4
+
+# Set default charset
+[*.{html,xml,js,css,py}]
+charset = utf-8
+
+# python
+[*.py]
+indent_style = space
+indent_size = 4
+
+# webdev + terraform
+[*.{html,xml,js,css,gql,tf,tfvars}]
+indent_style = space
+indent_size = 2

.github/FUNDING.yml

@@ -0,0 +1,13 @@
+# These are supported funding model platforms
+
+github: [pythoninthegrass]
+# custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']
+# patreon: # Replace with a single Patreon username
+# open_collective: # Replace with a single Open Collective username
+# ko_fi: # Replace with a single Ko-fi username
+# tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
+# community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
+# liberapay: # Replace with a single Liberapay username
+# issuehunt: # Replace with a single IssueHunt username
+# otechie: # Replace with a single Otechie username
+# lfx_crowdfunding: # Replace with a single LFX Crowdfunding project-name e.g., cloud-foundry

.github/dependabot.yml

@@ -0,0 +1,17 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+# https://docs.github.com/en/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file#package-ecosystem
+# https://docs.github.com/en/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file#directory
+
+version: 2
+updates:
+  - package-ecosystem: "pip"      # package manager
+    directory: "/"                # Files stored in repository root
+    schedule:
+      interval: "weekly"
+      day: "saturday"
+      time: "10:00"
+      timezone: "America/Chicago"
+    open-pull-requests-limit: 5

.github/workflows/auto_merge.yml

@@ -0,0 +1,27 @@
+# https://docs.github.com/en/code-security/dependabot/working-with-dependabot/automating-dependabot-with-github-actions#approve-a-pull-request
+
+name: auto_merge
+on: [pull_request, workflow_dispatch]     # pull_request, push, workflow_dispatch
+
+permissions:
+  pull-requests: write
+
+jobs:
+  dependabot:
+    runs-on: ubuntu-latest
+    if: ${{ github.actor == 'dependabot[bot]' }}
+    steps:
+      - name: Dependabot metadata
+        id: metadata
+        uses: dependabot/fetch-metadata@v1.1.1
+        with:
+          github-token: "${{ secrets.GITHUB_TOKEN }}"
+      - name: Approve a PR
+        run: gh pr review --approve "$PR_URL"
+        env:
+          PR_URL: ${{github.event.pull_request.html_url}}
+          GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
+      - name: Merge a PR
+        run: gh pr merge "$PR_URL" --auto --squash
+        env:
+          PR_URL: ${{github.event.pull_request.html_url}}

.github/workflows/codeql_analysis.yml

@@ -0,0 +1,72 @@
+# For most projects, this workflow file will not need changing; you simply need
+# to commit it to your repository.
+#
+# You may wish to alter this file to override the set of languages analyzed,
+# or to provide custom queries or build logic.
+#
+# ******** NOTE ********
+# We have attempted to detect the languages in your repository. Please check
+# the `language` matrix defined below to confirm you have the correct set of
+# supported CodeQL languages.
+#
+name: codeql
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [ "main" ]
+  schedule:
+    - cron: '37 22 * * 4'
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ 'python' ]
+        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
+        # Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v3
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v2
+      with:
+        languages: ${{ matrix.language }}
+        # If you wish to specify custom queries, you can do so here or in a config file.
+        # By default, queries listed here will override any specified in a config file.
+        # Prefix the list here with "+" to use these queries and those in the config file.
+
+        # Details on CodeQL's query packs refer to : https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
+        # queries: security-extended,security-and-quality
+
+
+    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
+    # If this step fails, then you should remove it and run the build manually (see below)
+    - name: Autobuild
+      uses: github/codeql-action/autobuild@v2
+
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
+
+    #   If the Autobuild fails above, remove it and uncomment the following three lines.
+    #   modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance.
+
+    # - run: |
+    #   echo "Run, Build Application using script"
+    #   ./location_of_script_within_repo/buildscript.sh
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v2

.github/workflows/echo_secret.yml

@@ -0,0 +1,15 @@
+name: echo_secret
+
+on:
+  workflow_dispatch:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+    - shell: bash
+      env:
+        SUPER_SECRET: ${{ secrets.CREDS }}
+      run: |
+        echo "$SUPER_SECRET"

.github/workflows/hooks/pre-commit.py

@@ -0,0 +1,28 @@
+#!/usr/bin/env python3
+
+"""Helper script to be used as a pre-commit hook."""
+import os
+import sys
+import subprocess
+
+
+def gitleaksEnabled():
+    """Determine if the pre-commit hook for gitleaks is enabled."""
+    out = subprocess.getoutput("git config --bool hooks.gitleaks")
+    if out == "false":
+        return False
+    return True
+
+
+if gitleaksEnabled():
+    exitCode = os.WEXITSTATUS(os.system('gitleaks protect -v --staged'))
+    if exitCode == 1:
+        print('''Warning: gitleaks has detected sensitive information in your changes.
+To disable the gitleaks precommit hook run the following command:
+
+    git config hooks.gitleaks false
+''')
+        sys.exit(1)
+else:
+    print('gitleaks precommit disabled\
+     (enable with `git config hooks.gitleaks true`)')

.github/workflows/main.yml

@@ -0,0 +1,16 @@
+name: gitleaks
+
+on: [pull_request, push, workflow_dispatch]
+
+jobs:
+  scan:
+    name: gitleaks
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+      - uses: gitleaks/gitleaks-action@v2
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          GITLEAKS_LICENSE: ${{ secrets.GITLEAKS_LICENSE}} # Only required for Organizations, not personal accounts.

.github/workflows/python_test.yml

@@ -0,0 +1,90 @@
+# https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python
+# https://github.com/actions/setup-python/blob/main/docs/advanced-usage.md#caching-packages
+# https://www.peterbe.com/plog/install-python-poetry-github-actions-faster
+
+name: python_test
+
+on:
+  workflow_dispatch:
+  # push:
+  #   branches:
+  #   - main
+  # pull_request:
+
+jobs:
+  ci:
+    strategy:
+      matrix:
+        python-version: ["3.10", "3.11"]
+        os: ["ubuntu-latest"]
+        arch: ['x64']
+
+    runs-on: ${{ matrix.os }}
+
+    steps:
+    - name: checkout repo content
+      uses: actions/checkout@v3
+    # TODO: debug 'cache not found for input keys dotlocal-Linux-8e1cebf...'
+    # - name: load cached $HOME/.local
+    #   uses: actions/cache@v2.1.6
+    #   id: cash-money
+    #   with:
+    #     path: ~/.local
+    #     key: dotlocal-${{ runner.os }}-${{ hashFiles('.github/workflows/python_test.yml') }}
+    # - run: echo '${{ steps.cash-money.outputs.cache-hit }}'     # true if cache-hit occured on the primary key
+    # TODO: use `git config --global --add safe.directory` to find working dir (may need to set under checkout step)
+    - name: set cwd and change to directory
+      run: |
+        CWD=$(basename $(git rev-parse --show-toplevel))
+        BASE_DIR=$(cat BASE_DIR)
+        echo "BASE_DIR=$BASE_DIR" >> $GITHUB_ENV
+        cd ${{ env.BASE_DIR }} || unset BASE_DIR; \
+        BASE_DIR="$(pwd)/work/${CWD}/${CWD}" && echo "BASE_DIR=$BASE_DIR" >> $GITHUB_ENV; \
+        cd ${{ env.BASE_DIR }}
+    # - run: ls -la ${{ env.BASE_DIR }}
+    - name: Read .tool-versions                                 # dynamic versions
+      uses: marocchino/tool-versions-action@v1
+      id: versions
+      with:
+        path: ${{ env.BASE_DIR }}/.tool-versions
+    - name: shuffle files
+      run: |
+        cat ${{ env.BASE_DIR }}/.tool-versions | awk '/python/ {print $NF}' >> ${{ env.BASE_DIR }}/.python-version
+        # [[ -e "$(pwd)/pyproject.toml" ]] && mv "$(pwd)/pyproject.toml" "$(pwd)/pyproject.toml.bak"
+        # cp "${{ env.BASE_DIR }}/pyproject.toml" $(pwd)/
+    - name: setup python
+      uses: actions/setup-python@v4
+      with:
+        python-version-file: ${{ env.BASE_DIR }}/.python-version
+        cache: 'pip'
+    - name: setup poetry
+      uses: snok/install-poetry@v1
+      id: cp310
+      with:
+        version: ${{ steps.versions.outputs.poetry }}
+        virtualenvs-create: true
+        virtualenvs-in-project: true
+        virtualenvs-path: ${{ env.BASE_DIR }}
+        installer-parallel: true
+    - name: load cached venv
+      id: cached-poetry-dependencies
+      uses: actions/cache@v2.1.6
+      with:
+        path: ${{ env.BASE_DIR }}/.venv
+        key: venv-${{ runner.os }}-${{ hashFiles('**/poetry.lock') }}-${{ hashFiles('.github/workflows/python_test.yml') }}
+    - name: install virtualenv
+      run: |
+        cd ${{ env.BASE_DIR }}
+        poetry install
+      if: steps.cached-poetry-dependencies.outputs.cache-hit != 'true'
+    - name: Lint with flake8
+      run: |
+        # stop the build if there are Python syntax errors or undefined names
+        poetry run flake8 ${{ env.BASE_DIR }} --count --select=E9,F63,F7,F82 --show-source --statistics
+        # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
+        poetry run flake8 ${{ env.BASE_DIR }} --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
+    # TODO: write tests
+    - name: Test with pytest
+      run: |
+        # exit code 5 == 'collected 0 items'
+        poetry run pytest ${{ env.BASE_DIR }}