Deploy updated docs

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,27 @@
+---
+name: Bug Report
+about: Create a report to help us improve
+title: "[Bug] "
+labels: bug
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '...'
+3. Scroll down to '...'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/documentation_request.md

@@ -0,0 +1,17 @@
+---
+name: Documentation Request
+about: Suggest changes or additions to the project documentation
+title: "[Documentation] "
+labels: documentation
+assignees: ''
+
+---
+
+**What documentation needs to be updated?**
+A clear and concise description of the documentation that needs to be updated.
+
+**Describe the changes needed**
+What specific changes or additions do you propose?
+
+**Additional context**
+Add any other context about the documentation request here.

.github/ISSUE_TEMPLATE/enhancement_request.md

@@ -0,0 +1,23 @@
+---
+name: Enhancement Request
+about: Suggest an improvement or enhancement for the project
+title: "[Enhancement] "
+labels: enhancement
+assignees: ''
+
+---
+
+**Describe the enhancement**
+A clear and concise description of the proposed enhancement or improvement.
+
+**Why is this enhancement necessary?**
+Explain why this enhancement would be beneficial for the project.
+
+**Proposed solution**
+Describe how you would implement this enhancement.
+
+**Alternatives considered**
+If applicable, mention any alternative solutions you've considered.
+
+**Additional context**
+Add any other context or screenshots related to the enhancement here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature Request
+about: Suggest an idea for this project
+title: "[Feature] "
+labels: enhancement
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of the problem you're trying to solve.
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.github/ISSUE_TEMPLATE/test_request.md

@@ -0,0 +1,20 @@
+---
+name: Test Request
+about: Request to add or modify tests for the project
+title: "[Test] "
+labels: test
+assignees: ''
+
+---
+
+**Describe the test request**
+A clear and concise description of what you want to test or modify in the existing tests.
+
+**Motivation**
+Explain why this test is important.
+
+**Steps to Reproduce**
+Provide any relevant steps or code snippets.
+
+**Additional context**
+Add any other context about the test request here.

.github/ISSUE_TEMPLATE/workflow_request.md

@@ -0,0 +1,20 @@
+---
+name: Workflow Request
+about: Suggest changes to the project's workflow or process
+title: "[Workflow] "
+labels: workflow
+assignees: ''
+
+---
+
+**What workflow needs to be updated?**
+A clear and concise description of the workflow that needs to be updated.
+
+**Describe the proposed changes**
+What specific changes do you propose for the workflow?
+
+**Motivation**
+Explain why this change is necessary.
+
+**Additional context**
+Add any other context about the workflow request here.

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,29 @@
+## Description
+
+Please include a summary of the change and which issue is fixed. Also include relevant motivation and context.
+
+- Fixes #(issue number)
+
+## Type of change
+
+Please delete options that are not relevant.
+
+- [ ] Bug fix (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
+- [ ] Tests update
+
+## Checklist
+
+- [ ] My code follows the style guidelines of this project
+- [ ] I have performed a self-review of my own code
+- [ ] I have commented my code, particularly in hard-to-understand areas
+- [ ] My changes generate no new warnings
+- [ ] New and existing unit tests pass locally with my changes
+- [ ] I have maintained a clean commit history by using the necessary Git commands
+- [ ] I have checked that my code does not cause any merge conflicts
+
+## Screenshots (if applicable)
+
+Add screenshots to help explain the changes (if necessary).

.github/workflows/ci.yml

@@ -0,0 +1,36 @@
+name: Build and Deploy MkDocs Site
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: 3.9
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install mkdocs mkdocs-material
+
+      - name: Build the site
+        run: mkdocs build
+
+      - name: Deploy to GitHub Pages
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          deploy_branch: gh-pages
+          folder: site

.github/workflows/test.yml

@@ -0,0 +1,32 @@
+name: Run Tests
+
+on:
+  push:
+    branches:
+      - '**'
+  pull_request:
+    branches:
+      - '**'
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+
+      - name: Set up Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: '3.8' 
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install poetry
+          poetry install
+
+      - name: Run tests
+        run: |
+          poetry run pytest tests/*.py

.gitignore

@@ -0,0 +1,153 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Virtual environment
+.venv/
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Poetry virtual environment
+.cache/
+.pdm.toml
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+*.egg-info/
+.installed.cfg
+*.egg
+*.whl
+
+# PyInstaller
+*.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/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# pipenv
+Pipfile
+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
+
+# Miscellaneous
+*.db-journal
+*.db
+
+# Issue tracker files
+/issue
+
+# Python test coverage cache
+/.pytest_cache/
+
+# Build files
+build/
+dist/
+*.whl
+*.tar.gz
+
+# TwinTrim build artifacts
+build/
+dist/
+*.egg-info/
+
+# VSCode settings
+.vscode/
+
+# Test files
+test.py
+
+# Ignore the search index
+search/search_index.json

.vscode/settings.json

@@ -0,0 +1,7 @@
+{
+  "python.testing.pytestArgs": [
+    "tests"
+  ],
+  "python.testing.unittestEnabled": false,
+  "python.testing.pytestEnabled": true
+}