feat: init

.github/workflows/black.yml

@@ -0,0 +1,13 @@
+name: Lint
+
+on: workflow_dispatch
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: psf/black@stable
+        with:
+          src: "./src"
+          jupyter: true

.github/workflows/build_docs.yaml

@@ -0,0 +1,54 @@
+name: Build Documentation
+
+on:
+  push:
+    branches: [ develop ]
+    paths: [ 'docs/**' ]
+  workflow_dispatch:
+
+jobs:
+  deploy:
+    strategy:
+      matrix:
+        python-version: [ "3.9" ]
+
+    runs-on: ubuntu-latest
+
+    permissions:
+      contents: write
+      pages: write
+      id-token: write
+
+    concurrency:
+      group: ${{ github.workflow }}-${{ github.ref }}
+
+    steps:
+      - name: Checkout GitHub Pages
+        uses: actions/checkout@v4
+
+      - name: Setup Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v3
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install Dependencies
+        run: |
+          python3 -m pip install --upgrade pip
+          pip install -e '.[docs]'
+
+      - name: Setup Pages
+        uses: actions/configure-pages@v4
+
+      - name: Build HTML with Sphinx
+        run: |
+          cd docs
+          make html
+
+      - name: Upload Artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: './docs/build/html'
+
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.github/workflows/deploy.yml

@@ -0,0 +1,52 @@
+name: deploy
+
+on:
+  release:
+  workflow_dispatch:
+
+jobs:
+  deploy:
+      runs-on: ${{ matrix.operating-system }}
+      strategy:
+        matrix:
+          python-version: ["3.9"]
+          operating-system: [windows-latest]
+      steps:
+        - uses: actions/checkout@v3
+          with:
+            fetch-depth: 0
+        - name: Create .pypirc file
+          shell: pwsh
+          run: |
+            @"
+            [distutils]
+            index-servers =
+              pypi
+              navigate-micro
+    
+            [pypi]
+            repository: https://upload.pypi.org/legacy/
+            username: $env:PYPI_USERNAME
+            password: $env:PYPI_PASSWORD
+            
+            [navigate-micro]
+            repository: https://upload.pypi.org/legacy/
+            username: $env:PYPI_USERNAME
+            password: $env:PYPI_PASSWORD
+            "@ | Set-Content -Path $env:USERPROFILE\.pypirc
+        - name: Set up Python ${{ matrix.python-version }}
+          uses: actions/setup-python@v3
+          with:
+            python-version: ${{ matrix.python-version }}
+        - name: Install dependencies
+          run: |
+            python -m pip install --upgrade pip
+            pip install -U setuptools build twine
+        - name: Build and publish
+          env:
+            TWINE_USERNAME: __token__
+            TWINE_PASSWORD: ${{ secrets.TWINE_API_KEY }}
+          run: |
+            git tag
+            python -m build
+            twine upload -r navigate-micro dist/* 

.github/workflows/push_checks.yaml

@@ -0,0 +1,43 @@
+# https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python
+name: Tests
+
+on:
+  push:
+    branches:
+      - develop
+  pull_request:
+  workflow_dispatch:
+
+jobs:
+  test:
+    runs-on: ${{ matrix.operating-system }}
+    strategy:
+      matrix:
+        python-version: ["3.9"]
+        operating-system: [windows-latest]  # [ubuntu-latest, windows-latest]
+    env:
+      MPLBACKEND: Agg  # https://github.com/microsoft/azure-pipelines-tasks/issues/16426
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v3
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -e '.[dev]'
+      - name: Test with pytest
+        run: |
+          python3 -m pytest
+      - name: Codecov
+        uses: codecov/codecov-action@v3.1.0
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          directory: ./coverage/reports/
+          env_vars: OS,PYTHON
+          fail_ci_if_error: false
+          files: ./coverage.xml
+          flags: unittests
+          name: codecov-umbrella
+          verbose: true