GitHub Automation Minus Python Static Checking

[davidvonthenen]

Proposed changes

This is all of the GitHub automation copied from the Go PR (https://github.com/deepgram/deepgram-go-sdk) minus the Go static checking and lining.

Prerequisites

Supported Environment:

• Linux: Ubuntu and Redhat only
• MacOS

NOTE: No windows support. Just submit the PR and use the PR to tell you what static checks and lints to fix.

In order to expedite implementation this feature, this does require the following to be installed:

• docker: https://www.docker.com/get-started/

Once you have docker installed, all other dependencies can be installed using:

make ensure-deps

NOTE: Just like this sounds, it will install things on your local laptop.

Significant Changes

• Markdown linting - which is why you see all .md files changing
• Yaml/GitHub Action static checking and lining - which is why you see all YAML and Actions changing
• Shellscript static checking and lining - to support all these linters bash scripts ahead to be introduced to orchestrate invoking these tools
• Makefile (and scripts) - these are cross-platform to help orchestrate these checks and for users to be able to run these checks locally BEFORE submitting a PR

To Run Locally:

You need to have cmake installed. Then just run:
make help

vonthd@vonthds-MacBook-Pro-2:deepgram-go-sdk$ make help

Syntax: make <target>

Targets:
  help            Display help
  version         display version of components
  ensure-deps     Ensure that all required dependency utilities are downloaded or installed
  lint            Performs Golang programming lint
  mdlint          Performs Markdown lint
  shellcheck      Performs bash/shell lint
  yamllint        Performs yaml lint
  actionlint      Performs GitHub Actions lint

Types of changes

What types of changes does your code introduce to the community Python SDK?
Put an x in the boxes that apply

• Bugfix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• Documentation update or tests (if none of the other choices apply)

Checklist

Put an x in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your code.

• I have read the CONTRIBUTING doc
• I have lint'ed all of my code using repo standards
• I have added tests that prove my fix is effective or that my feature works
• I have added necessary documentation (if appropriate)

Further comments