.github/workflows/coverage.yml

@@ -0,0 +1,27 @@
+# This is a follow up job that runs after the CI job has completed.
+# It'll post a code coverage comment on pull requests.
+name: Post Coverage Comment
+
+on:
+  workflow_run:
+    workflows: ["Continuous Integration"]
+    types:
+      - completed
+
+jobs:
+  test:
+    name: Post Coverage Comment
+    runs-on: ubuntu-latest
+    if: github.event.workflow_run.event == 'pull_request' && github.event.workflow_run.conclusion == 'success'
+    permissions:
+      pull-requests: write
+      contents: write
+      actions: read
+    steps:
+      # !!! DO NOT run actions/checkout here, for security reasons !!!
+      # For details, refer to https://securitylab.github.com/research/github-actions-preventing-pwn-requests/
+      - name: Post comment
+        uses: py-cov-action/python-coverage-comment-action@v3
+        with:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          GITHUB_PR_RUN_ID: ${{ github.event.workflow_run.id }}

.github/workflows/docs.yml

@@ -0,0 +1,28 @@
+name: docs
+on:
+  push:
+    branches:
+      - main
+permissions:
+  contents: write
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Configure Git Credentials
+        run: |
+          git config user.name github-actions[bot]
+          git config user.email 41898282+github-actions[bot]@users.noreply.github.com
+      - uses: actions/setup-python@v5
+        with:
+          python-version: 3.x
+      - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV 
+      - uses: actions/cache@v4
+        with:
+          key: mkdocs-material-${{ env.cache_id }}
+          path: .cache
+          restore-keys: |
+            mkdocs-material-
+      - run: pip install mkdocs-material 
+      - run: mkdocs gh-deploy --force

.github/workflows/test.yml

@@ -0,0 +1,50 @@
+name: Continuous Integration
+
+on:
+    pull_request:
+    push:
+      branches:
+        - "main"
+
+env:
+    PYTEST_ADDOPTS: "--color=yes"
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      pull-requests: write
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install a specific version of uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          version: "0.6.3"
+          enable-cache: true
+      - run: uv python install  # Will read from .python-version
+      - name: Install Dependencies
+        run: uv sync --all-extras --dev
+      - name: Run Tests
+        run: |
+            uv run make test-ci
+      - name: Attach Code Coverage
+        uses: py-cov-action/python-coverage-comment-action@v3.25
+        with:
+            GITHUB_TOKEN: ${{ github.token }}
+
+      - name: Save Snapshot Report
+        if: always()
+        uses: actions/upload-artifact@v4
+        with:
+          name: snapshot-report-posting
+          path: snapshot_report.html
+
+      - name: Store Pull Request Comment
+        uses: actions/upload-artifact@v4
+        if: steps.coverage_comment.outputs.COMMENT_FILE_WRITTEN == 'true'
+        with:
+            # If you use a different name, update COMMENT_ARTIFACT_NAME accordingly
+            name: python-coverage-comment-action
+            # If you use a different name, update COMMENT_FILENAME accordingly
+            path: python-coverage-comment-action.txt

.gitignore

@@ -7,4 +7,14 @@ wheels/
 *.egg-info
 
 # venv
-.venv
+.venv
+
+# editor
+.vscode/
+.idea/
+
+snapshot_report.html
+*.afdesign
+*.afdesign*
+*.afphoto
+*.afphoto*

CONTRIBUTING.md

@@ -0,0 +1,26 @@
+# Contributing to Posting
+
+Posting is open to contributions! 🚀
+
+Contributions of any type, no matter the "size" and form, are welcome!
+Bug reports, typo fixes, ideas, questions, and code are all valuable ways of contributing.
+If you're new to open source and would like a bit of extra guidance, don't be afraid to ask - we all start somewhere 😌
+
+## How do I contribute?
+
+You can suggest ideas by creating a discussion, or report bugs by creating an issue.
+
+If you wish to contribute code, and it's a change which is not an "objective improvement", please open a discussion first.
+An "objective improvement" is a change which _indisputably_ improves Posting.
+Some examples include adding test coverage, performance improvements, bug fixes, and fixing clear inconsistencies.
+
+By opening a discussion, we can make sure:
+
+- You're not working on something that someone else has already started.
+- The feature is within Posting's scope.
+- We can iron out the details before you go and commit a bunch of time to it!
+- Maintainers can give you tips, and the discussion will be a place you can ask for help and guidance.
+
+---
+
+This file is still a work in progress...

Makefile

@@ -0,0 +1,15 @@
+
+.PHONY: test
+test:
+	$(run) pytest --cov=posting tests/ -n 24 -m "not serial" $(ARGS)
+	$(run) pytest --cov-report term-missing --cov-append --cov=posting tests/ -m serial $(ARGS)
+
+.PHONY: test-snapshot-update
+test-snapshot-update:
+	$(run) pytest --cov=posting tests/ -n 24 -m "not serial" --snapshot-update $(ARGS)
+	$(run) pytest --cov-report term-missing --cov-append --cov=posting tests/ -m serial --snapshot-update $(ARGS)
+
+
+.PHONY: test-ci
+test-ci:
+	$(run) pytest --cov=posting tests/ --cov-report term-missing $(ARGS)