Add project/source, testing/linting, and README/docs files.

NillionNetwork · Nov 6, 2024 · b2d79c2 · b2d79c2
1 parent cf97238
commit b2d79c2
Show file tree

Hide file tree

Showing 17 changed files with 1,186 additions and 2 deletions.
diff --git a/.github/workflows/lint-test-cover-docs.yml b/.github/workflows/lint-test-cover-docs.yml
@@ -0,0 +1,37 @@
+name: lint-test-cover-docs
+on:
+  push:
+    branches:
+      - '**'
+  workflow_call: # If invoked by build-publish-sign-release workflow.
+jobs:
+  lint_test_cover_docs:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ['3.11', '3.12']
+    name: Python ${{ matrix.python-version }}
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install Python.
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+          architecture: x64
+      - name: Lint and test module.
+        run: |
+          pip install -U .[lint,test]
+          python -m pylint nilql test/test_nilql.py # Check against linting rules.
+          python -m pytest # Run tests.
+      - name: Publish coverage results.
+        run: |
+          pip install -U .[coveralls]
+          python -m coveralls --service=github # Submit to coveralls.
+        if: matrix.python-version == '3.11'
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          COVERALLS_REPO_TOKEN: ${{ secrets.COVERALLS_REPO_TOKEN }}
+      - name: Test auto-generation of documentation.
+        run: |
+          pip install -U .[docs]
+          cd docs && sphinx-apidoc -f -E --templatedir=_templates -o _source .. && make html && cd ..