Initial commit

.devcontainer/Dockerfile

@@ -0,0 +1,5 @@
+# See here for image contents: https://github.com/microsoft/vscode-dev-containers/tree/v0.245.0/containers/python-3/.devcontainer/base.Dockerfile
+
+# [Choice] Python version (use -bullseye variants on local arm64/Apple Silicon): 3, 3.10, 3.9, 3.8, 3.7, 3.6, 3-bullseye, 3.10-bullseye, 3.9-bullseye, 3.8-bullseye, 3.7-bullseye, 3.6-bullseye, 3-buster, 3.10-buster, 3.9-buster, 3.8-buster, 3.7-buster, 3.6-buster
+ARG VARIANT="3.10-bullseye"
+FROM mcr.microsoft.com/devcontainers/python:${VARIANT}

.devcontainer/devcontainer.json

@@ -0,0 +1,37 @@
+// For format details, see https://aka.ms/devcontainer.json. For config options, see the
+// README at: https://github.com/devcontainers/templates/tree/main/src/python
+{
+	"name": "Python 3",
+	"build": {
+		"dockerfile": "Dockerfile",
+		"context": "..",
+		"args": {
+			// Update 'VARIANT' to pick a Python version: 3, 3.12, 3.11, 3.10, 3.9
+			// Append -bullseye or -buster to pin to an OS version.
+			// Use -bullseye variants on local on arm64/Apple Silicon.
+			"VARIANT": "3.10-bullseye"
+		}
+	},
+	"customizations": {
+		"codespaces": {
+			"openFiles": [
+				"CONTRIBUTING.md"
+			]
+		},
+		"vscode": {
+			"extensions": [
+				"bierner.github-markdown-preview",
+				"charliermarsh.ruff",
+				"davidanson.vscode-markdownlint",
+				"ms-python.python",
+				"ms-python.vscode-pylance",
+				"njpwerner.autodocstring",
+				"redhat.vscode-yaml",
+				"tamasfe.even-better-toml"
+			]
+		}
+	},
+	"postCreateCommand": ".devcontainer/post-create.sh",
+	// Comment out to connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root.
+	"remoteUser": "vscode"
+}

.devcontainer/post-create.sh

@@ -0,0 +1,3 @@
+#!/usr/bin/env bash
+python -m pip install -r requirements-dev.txt
+pre-commit install

.github/CODEOWNERS

@@ -0,0 +1,9 @@
+# GitHub code owners file. For more info: https://help.github.com/articles/about-codeowners/
+#
+# - Comment lines begin with `#` character.
+# - Each line is a file pattern followed by one or more owners.
+# - The '*' pattern is global owners.
+# - Order is important. The last matching pattern has the most precedence.
+
+# Global
+* @lekic

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,41 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: 'bug: <title>'
+labels: [bug]
+assignees: ''
+
+---
+
+## Describe the bug
+
+A clear and concise description of what the bug is.
+
+## Steps to reproduce
+
+Steps to reproduce the behavior:
+
+1. [List the steps required to reproduce the bug.]
+2. [Continue listing steps if necessary.]
+
+## Expected behaviour
+
+[A clear and concise description of what you expected to happen.]
+
+## Actual behaviour
+
+[Describe what actually happened when performing the steps above, including any error messages or unexpected behavior.]
+
+## Screenshots/Logs
+
+If applicable, add screenshots and/or to help explain your problem.
+
+## Environment
+
+- OS: [e.g. RHEL7, Ubuntu]
+- Python version: [e.g. 3.9, 3.10]
+- Dependencies/Modules: [List any relevant dependencies or modules]
+
+## Additional context
+
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,24 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: 'feat: <title>'
+labels: [enhancement]
+assignees: ''
+
+---
+
+## Is your feature request related to a problem? Please describe
+
+A clear and concise description of what the problem is. E.g. I'm always frustrated when [...]
+
+## 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/dependabot.yml

@@ -0,0 +1,15 @@
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+  - package-ecosystem: "pip"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+# registries:
+#   python:
+#     type: python-index
+#     url: https://example.com/_packaging/my-feed/pypi/example
+#     replaces-base: true

.github/pull_request_template.md

@@ -0,0 +1,24 @@
+## Description
+<!--- Describe the changes introduced by this pull request -->
+<!--- What problem does it solve? -->
+<!--- If it fixes an open issue, please link to the issue here -->
+
+## Type of change
+<!--- Check all applicable items with [x] -->
+
+- [ ] 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 (if none of the other choices apply)
+
+## Checklist
+
+- [ ] My code follows the project's coding style guidelines
+- [ ] I have performed a self-review of my own code
+- [ ] I have commented my code, particularly in hard-to-understand areas
+- [ ] I have made corresponding changes to the documentation
+- [ ] My changes pass all linting and tests
+- [ ] I have added tests that prove my fix is effective or that my feature works
+
+## Additional Information
+<!--- Any additional information or context that would be helpful -->

.github/workflows/ci.yml

@@ -0,0 +1,35 @@
+name: CI
+on:
+  pull_request:
+  push:
+    branches:
+      - main
+jobs:
+  build:
+    name: Python
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version:
+          - "3.9"
+          - "3.10"
+          - "3.11"
+          - "3.12"
+    steps:
+        - uses: actions/checkout@v4
+        - name: Set up Python ${{ matrix.python-version }}
+          uses: actions/setup-python@v5
+          with:
+            python-version: ${{ matrix.python-version }}
+        - name: Install dependencies
+          run: |
+            python -m pip install --upgrade pip
+            pip install -r requirements-dev.txt
+        - name: Lint with ruff
+          run: ruff check --no-fix
+        - name: Format with ruff
+          run: ruff format --check
+        - name: Run type checking with mypy
+          run: mypy .
+        - name: Run unit tests
+          run: pytest

.github/workflows/markdown-link-checker.yml

@@ -0,0 +1,17 @@
+name: Markdown Links
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+  schedule:
+    # Run every Tuesday at 3:00 AM (See https://pubs.opengroup.org/onlinepubs/9699919799/utilities/crontab.html#tag_20_25_07)
+    - cron: "0 3 * * 2"
+jobs:
+  markdown-link-check:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: gaurav-nelson/github-action-markdown-link-check@v1