add docs artifact

.gitea/workflows/test.yaml

@@ -0,0 +1,54 @@
+name: Test bankfind
+run-name: ${{ gitea.actor }} is testing out bankfind 🐍
+on:
+  - push
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: [ '3.8' ]
+    name: Python ${{ matrix.python-version }} sample
+    steps:
+      - uses: actions/checkout@v2
+      - name: Setup python
+        uses: actions/setup-python@v2
+        with:
+          python-version: ${{ matrix.python-version }}
+          architecture: x64
+      - name: Setup Tests and Dependencies
+        run: |
+          python --version
+          pip install -U pip
+          pip install pytest coverage pytest-cov
+          pip install -r requirements.txt
+      - name: Run tests
+        run: |
+          pytest
+      - name: build package with flit
+        run: |
+          pip install -U flit
+          flit build
+          find dist
+      - name: upload package as artifact
+        # v4 doesn't work
+        # uses: actions/upload-artifact@v4
+        uses: actions/upload-artifact@v3
+        with:
+          name: bankfind
+          path: dist
+      - name: Build docs with mkdocs
+        run: |
+          pip install mkdocs mkdocs-material mkdocs-material-extensions
+          cd docs
+          mkdocs build
+          find site
+      - name: upload docs as artifact
+        # v4 doesn't work
+        # uses: actions/upload-artifact@v4
+        uses: actions/upload-artifact@v3
+        with:
+          name: bankfind-docs
+          path: docs/site
+

README.md

@@ -70,3 +70,16 @@ data = bf.get_institutions(filters="STNAME:Colorado AND SUBCHAPS:0 AND CB:1")
 ## License
 
 This project is licensed under the terms of the MIT license.
+
+## Development
+
+### Running Tests Locally
+
+```bash
+brew install python@3.8
+mkvirtualenv -p /opt/homebrew/bin/python3.8 bankfind
+pip install -U pip
+pip install pytest coverage pytest-cov
+pip install -r requirements.txt
+pytest
+```