feat(tests and documentation): Improving documentation/docstring and starting fil test files #37

	name: Python Actions
	on:
	push:
	branches: [ main ]
	pull_request:
	branches: [ main ]
	workflow_dispatch:

	jobs:
	linting:
	runs-on: ubuntu-latest
	steps:
	- name: Checkout code
	uses: actions/checkout@v4

	# - name: Set up Python
	# uses: actions/setup-python@v5
	# with:
	# python-version: '3.12'
	# cache: 'pip'

	- name: Install requirements
	run: \|
	python3 -m pip install -r requirements.txt

	- name: Venv in Github Path
	run: echo "$PWD/.venv/bin" >> $GITHUB_PATH

	- name: Black
	uses: microsoft/[email protected]
	with:
	python_version: '3.12'
	black: true
	workdir: "."

	- name: Bandit
	uses: microsoft/[email protected]
	with:
	python_version: '3.12'
	bandit: true
	workdir: "."

	- name: Pylint
	uses: microsoft/[email protected]
	with:
	python_version: '3.12'
	pylint: true
	workdir: "."

	- name: Pyright
	uses: microsoft/[email protected]
	with:
	python_version: '3.12'
	pyright: true
	workdir: "."

	- name: Flake8
	uses: microsoft/[email protected]
	with:
	python_version: '3.12'
	flake8: true
	workdir: "."

	testing:
	runs-on: ubuntu-latest
	steps:
	- name: Checkout code
	uses: actions/checkout@v4

	# - name: Set up Python
	# uses: actions/setup-python@v5
	# with:
	# python-version: '3.12'
	# cache: pip

	# - name: Install requirements
	# run: \|
	# python3 -m pip install -r tests/requirements.txt

	- name: Pytest
	uses: microsoft/[email protected]
	with:
	python_version: '3.12'
	pytest: false
	testdir: "tests/"
	workdir: "."

Provide feedback