Minor documentation updates. Cleaning pyprojects. Adding extensions a…

…s extras.

.github/workflows/python-tests.yml

@@ -2,47 +2,46 @@ name: Test package
 
 on:
   push:
-    branches: [ main ]
+    branches: [main]
   pull_request:
-    branches: [ main ]
+    branches: [main]
+  workflow_dispatch:
 
 jobs:
   build:
-
     strategy:
       matrix:
-        python-version: [3.8, 3.9, '3.10']
+        python-version: [3.8, 3.9, "3.10"]
         os:
-          - 'ubuntu-latest'
-          - 'windows-latest'
-          - 'macos-latest'
+          - "ubuntu-latest"
+          - "windows-latest"
+          - "macos-latest"
     runs-on: ${{matrix.os}}
 
     steps:
-
-    - uses: actions/checkout@v2
-
-    - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v2
-      with:
-        python-version: ${{ matrix.python-version }}
-
-    - name: Install dependencies
-      run: |
-        python -m pip install --upgrade pip poetry
-        poetry install --all-extras --with test
-    
-    - name: Lint with flake8
-      run: |
-        # stop the build if there are Python syntax errors or undefined names
-        flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
-        flake8 . --count --exit-zero --statistics
-    
-    - name: Test ezmsg
-      run: |
-        python -m pytest -v tests
-
-    - name: Test ezmsg-sigproc
-      run: |
-        python -m pytest -v extensions/ezmsg-sigproc/tests
+      - uses: actions/checkout@v2
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v2
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip pipx
+          pipx install poetry
+          poetry install -E zmq -E websocket -E sigproc --with test
+
+      - name: Lint with flake8
+        run: |
+          # stop the build if there are Python syntax errors or undefined names
+          flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
+          flake8 . --count --exit-zero --statistics
+
+      - name: Test ezmsg
+        run: |
+          python -m pytest -v tests
 
+      - name: Test ezmsg-sigproc
+        run: |
+          python -m pytest -v extensions/ezmsg-sigproc/tests

README.md

@@ -27,12 +27,14 @@ Testing `ezmsg` requires:
 ```bash
 $ python3 -m venv env
 $ source env/bin/activate
-(env) $ pip install --upgrade pip
-(env) $ pip install -e ".[test]"
+(env) $ pip install --upgrade pip poetry
+(env) $ poetry install --with test
 
 (env) $ python -m pytest tests # Optionally, Perform tests
 ```
 
+Note that it is generally recommended to install poetry into it's own standalone venv via the `pipx` cli tool.
+
 ## Documentation
 
 https://ezmsg.readthedocs.io/en/latest/
@@ -41,6 +43,21 @@ https://ezmsg.readthedocs.io/en/latest/
 
 ## Extensions
 
+`ezmsg` extensions can be installed individually or all at once. To install all the extension packages in one go, you can use the following command:
+
+```bash
+pip install "ezmsg[all_ext]"
+```
+
+This will install all the available public extension packages for `ezmsg` that are listed in `pyproject.toml`.
+If you prefer to install the extension packages individually, you can use the following command:
+
+```bash
+pip install "ezmsg[zmq,sigproc,...]"
+```
+
+Please note that the `ezmsg` package itself can still be installed without any additional extensions using `pip install ezmsg`.
+
 See the extension directory for more details
 
 - `ezmsg-sigproc` -- Timeseries signal processing modules

extensions/ezmsg-sigproc/pyproject.toml

@@ -6,7 +6,7 @@ authors = [
   "Milsap, Griffin <griffin.milsap@gmail.com>",
   "Peranich, Preston <pperanich@gmail.com>",
 ]
-license = "LICENSE.txt"
+license = "MIT"
 readme = "README.md"
 packages = [{ include = "ezmsg", from = "src" }]
 

extensions/ezmsg-websocket/pyproject.toml

@@ -6,9 +6,9 @@ authors = [
   "Milsap, Griffin <griffin.milsap@gmail.com>",
   "Peranich, Preston <pperanich@gmail.com>",
 ]
-license = "LICENSE.txt"
+license = "MIT"
 readme = "README.md"
-packages = [{ include = "ezmsg/websocket", from = "src" }]
+packages = [{ include = "ezmsg", from = "src" }]
 classifiers = [
   "Programming Language :: Python :: 3",
   "Operating System :: OS Independent",

extensions/ezmsg-zmq/pyproject.toml

@@ -6,9 +6,9 @@ authors = [
   "Milsap, Griffin <griffin.milsap@gmail.com>",
   "Peranich, Preston <pperanich@gmail.com>",
 ]
-license = "LICENSE.txt"
+license = "MIT"
 readme = "README.md"
-packages = [{ include = "ezmsg/zmq", from = "src" }]
+packages = [{ include = "ezmsg", from = "src" }]
 
 [tool.poetry.dependencies]
 python = "^3.8"

pyproject.toml

@@ -6,7 +6,7 @@ authors = [
   "Milsap, Griffin <griffin.milsap@gmail.com>",
   "Peranich, Preston <pperanich@gmail.com>",
 ]
-license = "LICENSE.txt"
+license = "MIT"
 readme = "README.md"
 packages = [{ include = "ezmsg", from = "src" }]
 classifiers = [
@@ -20,9 +20,17 @@ ezmsg = "ezmsg.core.command:cmdline"
 [tool.poetry.dependencies]
 python = "^3.8"
 typing-extensions = "^4.9.0"
-ezmsg-sigproc = { path = "./extensions/ezmsg-sigproc/", optional = true }
-ezmsg-websocket = { path = "./extensions/ezmsg-websocket/", optional = true }
-ezmsg-zmq = { path = "./extensions/ezmsg-zmq/", optional = true }
+ezmsg-sigproc = { version = "*", source = "pypi", optional = true }
+ezmsg-websocket = { version = "*", source = "pypi", optional = true }
+ezmsg-zmq = { version = "*", source = "pypi", optional = true }
+ezmsg-vispy = { version = "*", source = "pypi", optional = true }
+ezmsg-panel = { git = "https://github.com/griffinmilsap/ezmsg-panel.git", rev = "main", optional = true }
+ezmsg-blackrock = { python = "^3.9", git = "https://github.com/griffinmilsap/ezmsg-blackrock.git", rev = "main", optional = true }
+ezmsg-unicorn = { git = "https://github.com/griffinmilsap/ezmsg-unicorn.git", rev = "main", optional = true }
+ezmsg-gadget = { git = "https://github.com/griffinmilsap/ezmsg-gadget.git", rev = "main", optional = true }
+ezmsg-openbci = { git = "https://github.com/griffinmilsap/ezmsg-openbci.git", rev = "main", optional = true }
+ezmsg-ssvep = { git = "https://github.com/griffinmilsap/ezmsg-ssvep.git", rev = "main", optional = true }
+
 
 [tool.poetry.group.test.dependencies]
 pytest = "^7.0.0"
@@ -35,6 +43,25 @@ flake8 = "*"
 sigproc = ["ezmsg-sigproc"]
 websocket = ["ezmsg-websocket"]
 zmq = ["ezmsg-zmq"]
+panel = ["ezmsg-panel"]
+blackrock = ["ezmsg-blackrock"]
+unicorn = ["ezmsg-unicorn"]
+gadget = ["ezmsg-gadget"]
+openbci = ["ezmsg-openbci"]
+ssvep = ["ezmsg-ssvep"]
+vispy = ["ezmsg-vispy"]
+all_ext = [
+  "ezmsg-sigproc",
+  "ezmsg-websocket",
+  "ezmsg-zmq",
+  "ezmsg-panel",
+  "ezmsg-blackrock",
+  "ezmsg-unicorn",
+  "ezmsg-gadget",
+  "ezmsg-openbci",
+  "ezmsg-ssvep",
+  "ezmsg-vispy",
+]
 
 [tool.pytest.ini_options]
 addopts = ["--import-mode=importlib"]