Merge pull request #6 from gerlichlab/pixel-file-format

Pixel file format

.github/workflows/black_lint_test.yml

@@ -0,0 +1,32 @@
+name: Unittests
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    types: [opened, reopened, review_requested]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.8"]
+
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+      # You can test your matrix by printing the current Python version
+      - name: Install spoc, black, pylint and pytest
+        run: pip install . && pip install black==23.9.1 && pip install pylint==2.15.5 && pip install pytest
+      - name: Run black
+        run: black --check .
+      - name: Run pylint
+        run: pylint --fail-under=8 spoc/* tests/test_*.py
+      - name: Run tests
+        run: pytest .

.github/workflows/build_pages.yml

@@ -0,0 +1,25 @@
+name: Docs
+on:
+  push:
+    branches:
+      - master
+      - docs
+permissions:
+  contents: write
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v4
+        with:
+          python-version: 3.x
+      - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV 
+      - uses: actions/cache@v3
+        with:
+          key: mkdocs-material-${{ env.cache_id }}
+          path: .cache
+          restore-keys: |
+            mkdocs-material-
+      - run: pip install mkdocs-material && pip install mkdocstrings[python]
+      - run: mkdocs gh-deploy --force

.gitignore

@@ -108,5 +108,4 @@ ENV/
 # temp stuff
 playground/*
 
-#ignare local parquet files
-*.parquet
+#ignare local parquet files

.pylintrc

@@ -0,0 +1,2 @@
+[MASTER]
+extension-pkg-whitelist=pydantic # This is needed since pydantic has binary extensions

docs/cli.md

@@ -0,0 +1,3 @@
+# CLI
+
+::: spoc.cli