Initial commit

.github/ISSUE_TEMPLATE/bug_report.yaml

@@ -0,0 +1,47 @@
+name: Bug Report
+description: This is a template for reporting a bug.
+# If you want to enable automatic linking to projects,
+# uncomment the following line and replace the project ID
+# with the ID of your project.
+# projects: ["childmindresearch/1"]
+title: 'Bug: '
+labels: [bug]
+body:
+- type: textarea
+  id: description
+  attributes:
+    label: Description
+    description: Please provide a clear and concise description of the bug.
+    placeholder: Describe the bug here
+  validations:
+    required: true
+- type: textarea
+  id: steps-to-reproduce
+  attributes:
+    label: Steps to Reproduce
+    description: Please provide detailed steps to reproduce the bug.
+    placeholder: Describe the steps to reproduce the bug here.
+  validations:
+    required: true
+- type: textarea
+  id: expected-results
+  attributes:
+    label: Expected Results
+    description: Please describe what you expected to happen.
+    placeholder: Describe the expected results here.
+  validations:
+    required: true
+- type: textarea
+  id: actual-results
+  attributes:
+    label: Actual Results
+    description: Please describe what actually happened.
+    placeholder: Describe the actual results here.
+  validations:
+    required: true
+- type: textarea
+  id: additional-notes
+  attributes:
+    label: Additional Notes
+    description: Add any additional notes or context here.
+    placeholder: Add additional notes here.

.github/ISSUE_TEMPLATE/development_task.yaml

@@ -0,0 +1,32 @@
+name: Development Task
+description: This is a template for a development task
+# If you want to enable automatic linking to projects,
+# uncomment the following line and replace the project ID
+# with the ID of your project.
+# projects: ["childmindresearch/1"]
+title: 'Task: '
+labels: [task]
+body:
+- type: textarea
+  id: description
+  attributes:
+    label: Description
+    description: What is the task about? Why is it needed? What is the current state, if any?
+    placeholder: Describe the task here
+  validations:
+    required: true
+- type: textarea
+  id: tasks
+  attributes:
+    label: Tasks
+    description: What are the concrete (sub-)tasks that need to be performed?
+    placeholder: Describe the tasks here.
+    value: '- [ ] Task 1'
+  validations:
+    required: true
+- type: textarea
+  id: freeform-notes
+  attributes:
+    label: Freeform Notes
+    description: Add any additional notes here.
+    placeholder: Add notes here.

.github/ISSUE_TEMPLATE/support_request.yaml

@@ -0,0 +1,47 @@
+name: Support Request
+description: This is a template for submitting a support request.
+# If you want to enable automatic linking to projects,
+# uncomment the following line and replace the project ID
+# with the ID of your project.
+# projects: ["childmindresearch/1"]
+title: 'Support: '
+labels: [question]
+body:
+- type: textarea
+  id: issue-description
+  attributes:
+    label: Issue Description
+    description: Please provide a clear and concise description of the issue you are facing.
+    placeholder: Describe the issue here
+  validations:
+    required: true
+- type: textarea
+  id: environment-details
+  attributes:
+    label: Environment Details
+    description: Please provide details about your environment, including system specifications, software versions, etc.
+    placeholder: Describe your environment details here.
+  validations:
+    required: false
+- type: textarea
+  id: attempted-solutions
+  attributes:
+    label: Attempted Solutions
+    description: Describe any steps you have already taken to resolve the issue.
+    placeholder: Describe any attempted solutions here.
+  validations:
+    required: false
+- type: textarea
+  id: reproduction-steps
+  attributes:
+    label: Reproduction Steps
+    description: If applicable, provide steps to reproduce the issue.
+    placeholder: Describe the steps to reproduce the issue, if applicable.
+  validations:
+    required: false
+- type: textarea
+  id: additional-notes
+  attributes:
+    label: Additional Notes
+    description: Add any other context or screenshots about the support request here.
+    placeholder: Add additional notes or screenshots here.

.github/dependabot.yaml

@@ -0,0 +1,18 @@
+# Please see the documentation for all configuration options:
+# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+- package-ecosystem: pip
+  directory: /
+  schedule:
+    interval: monthly
+  groups:
+    production-dependencies:
+      dependency-type: production
+    development-dependencies:
+      dependency-type: development
+- package-ecosystem: github-actions
+  directory: /
+  schedule:
+    interval: monthly

.github/workflows/docs.yaml

@@ -0,0 +1,34 @@
+name: Build and publish docs
+
+permissions:
+  contents: write
+
+on:
+  workflow_run:
+    workflows: [Python Tests]
+    types:
+    - completed
+    branches:
+    - main
+
+jobs:
+  build-and-publish-docs:
+    if: ${{ github.event.workflow_run.conclusion == 'success' }}
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - uses: actions/setup-python@v5
+      with:
+        python-version-file: pyproject.toml
+    - name: Install dependencies
+      run: |
+        python -m pip install poetry
+        poetry install --with docs
+    - name: Build docs
+      run: |
+        APP_MODULE_NAME=$(ls src -U | head -1)  # Get the first module name in the src directory
+        poetry run pdoc src/"$APP_MODULE_NAME" -o docs_build -t docs/pdoc-theme --docformat google
+        touch docs_build/.nojekyll
+    - uses: JamesIves/github-pages-deploy-action@v4
+      with:
+        folder: docs_build

.github/workflows/test.yaml

@@ -0,0 +1,69 @@
+name: Python Tests
+
+on:
+  push:
+    branches:
+    - main
+  pull_request:
+
+jobs:
+  unit:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - name: Install poetry
+      run: pipx install poetry
+    - uses: actions/setup-python@v5
+      with:
+        python-version-file: pyproject.toml
+        cache: poetry
+    - name: Install dependencies
+      run: |
+        poetry install
+    - name: Run tests
+      id: run-tests
+      run: >
+        poetry run pytest \
+          --junitxml=pytest.xml \
+          --cov-report=term-missing:skip-covered \
+          --cov-report=xml:coverage.xml \
+          --cov=src tests \
+          --log-level=DEBUG \
+          --verbose
+    - name: Upload coverage to Codecov
+      uses: codecov/codecov-action@v4
+      with:
+        token: ${{ secrets.CODECOV_TOKEN }}
+        verbose: true
+
+  ruff:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - name: Install poetry
+      run: pipx install poetry
+    - uses: actions/setup-python@v5
+      with:
+        python-version-file: pyproject.toml
+        cache: poetry
+    - name: Install dependencies
+      run: |
+        poetry install
+    - name: Ruff format
+      run: poetry run ruff format --check
+    - name: Ruff check
+      run: poetry run ruff check
+
+  mypy:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - name: Install poetry
+      run: pipx install poetry
+    - uses: actions/setup-python@v5
+      with:
+        python-version: '3.11'
+        cache: poetry
+    - run: |
+        poetry install
+        poetry run mypy .