Merge pull request datajoint#6 from chris-langfield/main

Add CI and improve requirements

.github/workflows/python-package.yml → .github/workflows/tests.yaml

@@ -1,6 +1,9 @@
-name: Python Package
+name: poisson_numcodecs CI
 
 on:
+  push:
+    branches: [main]
+
   pull_request:
     branches: [main]
     types: [synchronize, opened, reopened, ready_for_review]
@@ -13,17 +16,17 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        os: ["ubuntu-latest", "macos-latest", "windows-latest"]
+        os: ["ubuntu-latest", "macos-latest"]
     steps:
       - uses: actions/checkout@v2
       - uses: s-weigand/setup-conda@v1
         with:
           python-version: 3.9
       - name: Install dependencies
         run: |
-          pip install .
-          pip install zarr
+          pip install -r requirements.txt
           pip install pytest
+          pip install .
       - name: Test with pytest 
         run: |
           pytest -v

README.md

@@ -1,4 +1,4 @@
-[![PyPI version](https://badge.fury.io/py/poisson-numcodecs.svg)](https://badge.fury.io/py/poisson-numcodecs) ![tests](https://github.com/AllenNeuralDynamics/poisson-numcodecs/actions/workflows/python-package.yml/badge.svg)
+[![PyPI version](https://badge.fury.io/py/poisson-numcodecs.svg)](https://badge.fury.io/py/poisson-numcodecs) ![tests](https://github.com/AllenNeuralDynamics/poisson-numcodecs/actions/workflows/tests.yaml/badge.svg)
 
 # Poisson - numcodecs implementation
 
@@ -17,12 +17,22 @@ Install via `pip`:
 pip install poisson-numcodecs
 ```
 
-Or from sources:
+### Developer installation
 
 ```
+conda create -n poisson_numcodecs python=3.xx
+conda activate poisson_numcodecs
 git clone https://github.com/AllenNeuralDynamics/poisson-numcodecs.git
 cd poisson-numcodecs
-pip install .
+pip install -r requirements.txt
+pip install -e .
+```
+
+Make sure everything works:
+
+```
+pip install pytest
+pytest tests/
 ```
 
 ## Usage
@@ -53,4 +63,4 @@ Available `**kwargs` can be browsed with: `Poisson?`
 
 **NOTE:** 
 In order to reload in zarr an array saved with the `Poisson`, you just need to have the `poisson_numcodecs` package
-installed.
+installed.

pyproject.toml

@@ -1,12 +1,10 @@
 [build-system]
-requires = ["setuptools>=61.0", "setuptools_scm>=8"]
+requires = ["setuptools>=61.0"]
 build-backend = "setuptools.build_meta"
 
-[tool.setuptools_scm]
-version_file = "_version.py"
-
 [project]
 name = "poisson_numcodecs"
+version = "0.1.0"
 authors = [
   { name="Jerome Lecoq", email="[email protected]" },
 ]

requirements.txt

@@ -2,4 +2,6 @@ numpy
 numcodecs
 zarr
 matplotlib
-scipy
+scipy
+scikit-learn
+imageio