Merge pull request labthings#13 from rwb27/CI-debug

Fix CI issues

.github/workflows/publish.yml

@@ -23,7 +23,7 @@ jobs:
         run: pip install -e .[dev]
 
       - name: Lint with Ruff
-        run: ruff check .
+        run: ruff check --format=github .
 
       - name: Analyse with MyPy
         run: mypy src

.github/workflows/test.yml

@@ -25,7 +25,7 @@ jobs:
         run: pip install -e .[dev]
 
       - name: Lint with Ruff
-        run: ruff --format=github check .
+        run: ruff check --format=github .
 
       - name: Analyse with MyPy
         run: mypy src
@@ -34,9 +34,11 @@ jobs:
         run: pytest --cov=src --cov-report=xml
 
       - name: Upload coverage to Codecov
-        uses: codecov/codecov-action@v1
+        uses: codecov/codecov-action@v3
         with:
           file: ./coverage.xml
           flags: unittests
           name: codecov-umbrella-${{ matrix.python }}
           fail_ci_if_error: false
+        env:
+          CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}

README.md

@@ -3,18 +3,13 @@ An experimental implementation of a LabThings server using fastapi.
 
 This is currently an incomplete implementation of the WoT specification, and will gradually grow as required to support the OpenFlexure server.
 
-## installation
+## Installation
 
-This is for my reference, until it's properly packaged:
+You can install this repository with `pip`, either clone it and run `pip install -e .[dev]` to work on it, or just `pip install https://gitlab.com/rwb27/labthings-fastapi.git`.
 
-```
-git clone [email protected]:rwb27/labthings-fastapi.git
-cd labthings-fastapi
-python --version
-python -m venv .venv --prompt="LabThings-FastAPI"
-source .venv/bin/activate # Windows: .venv/Scripts/activate
-pip install -e .
-```
+## Developer notes
+
+The code is linted with `ruff .`, type checked with `mypy src`, and tested with `pytest`. These all run in CI with GitHub Actions. The codebase is not even `v0.0.1` yet so it's still subject to summary rearrangement.
 
 ## Demo
 

pyproject.toml

@@ -21,6 +21,7 @@ dependencies = [
 [project.optional-dependencies]
 dev = [
   "pytest>=7.4.0, <8",
+  "pytest-cov",
   "mypy>=0.812",
   "ruff>=0.0.283",
   "types-jsonschema",