Merge pull request #128 from iscoe/cboulay/migrate_extensions

Eliminate extensions; migrated to ezmsg-org.

.github/workflows/python-tests.yml

@@ -37,7 +37,7 @@ jobs:
 
       - name: Install dependencies with Poetry
         run: |
-          poetry install -E zmq -E websocket -E sigproc --with test
+          poetry install --with test
 
       - name: Lint with flake8
         run: |
@@ -49,7 +49,3 @@ jobs:
       - name: Test ezmsg
         run: |
           poetry run python -m pytest -v tests
-
-      - name: Test ezmsg-sigproc
-        run: |
-          poetry run python -m pytest -v extensions/ezmsg-sigproc/tests

README.md

@@ -33,7 +33,7 @@ $ source env/bin/activate
 (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.
+Note that it is generally recommended to install poetry into its own standalone venv via the `pipx` cli tool.
 
 ## Documentation
 
@@ -50,25 +50,22 @@ 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:
+If you prefer to install a subset of extension packages, 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
-- `ezmsg-websocket` -- Websocket server and client nodes for `ezmsg` graphs
-- `ezmsg-zmq` -- ZeroMQ pub and sub nodes for `ezmsg` graphs
-- ... More to come!
-
-Additionally, the following extensions are contained in external repositories:
+Extensions can be managed manually as well. Here are some of the extensions we manage or are aware of:
 
+- [ezmsg-sigproc](https://github.com/ezmsg-org/ezmsg-sigproc) -- Timeseries signal processing modules
+- [ezmsg-websocket](https://github.com/ezmsg-org/ezmsg-websocket) -- Websocket server and client nodes for `ezmsg` graphs
+- [ezmsg-zmq](https://github.com/ezmsg-org/ezmsg-zmq) -- ZeroMQ pub and sub nodes for `ezmsg` graphs
 - [ezmsg-panel](https://github.com/griffinmilsap/ezmsg-panel) -- Plotting tools for `ezmsg` that use [panel](https://github.com/holoviz/panel)
 - [ezmsg-blackrock](https://github.com/griffinmilsap/ezmsg-blackrock) -- Interface for Blackrock Cerebus ecosystem (incl. Neuroport) using `pycbsdk`
+- [ezmsg-lsl](https://github.com/ezmsg-org/ezmsg-lsl) -- Source unit for LSL Inlet and sink unit for LSL Outlet
 - [ezmsg-unicorn](https://github.com/griffinmilsap/ezmsg-unicorn) -- g.tec Unicorn Hybrid Black integration for `ezmsg`
 - [ezmsg-gadget](https://github.com/griffinmilsap/ezmsg-gadget) -- USB-gadget with HID control integration for Raspberry Pi (Zero/W/2W, 4, CM4)
 - [ezmsg-openbci](https://github.com/griffinmilsap/ezmsg-openbci) -- OpenBCI Cyton serial interface for `ezmsg`

docs/source/conf.py

@@ -1,13 +1,3 @@
-import os
-import sys
-import importlib
-import inspect
-
-sys.path.insert(0, os.path.abspath('../../src'))
-sys.path.insert(0, os.path.abspath('../../extensions/ezmsg-sigproc/src'))
-# sys.path.insert(0, os.path.abspath('../../extensions/ezmsg-websocket/src'))
-# sys.path.insert(0, os.path.abspath('../../extensions/ezmsg-zmq/src'))
-
 # Configuration file for the Sphinx documentation builder.
 
 # -- Project information
@@ -50,8 +40,9 @@
 
 add_module_names = False
 
-
-code_url = f"https://github.com/iscoe/ezmsg/blob/dev/"
+branch = "dev"
+code_url = f"https://github.com/iscoe/ezmsg/blob/{branch}/"
+sigproc_code_url = f"https://github.com/ezmsg-org/ezmsg-sigproc/blob/{branch}/"
 
 
 def linkcode_resolve(domain, info):
@@ -61,7 +52,7 @@ def linkcode_resolve(domain, info):
         return None
     filename = info['module'].replace('.', '/')
     if "sigproc" in filename:
-        return f"{code_url}extensions/ezmsg-sigproc/src/{filename}.py"
+        return f"{sigproc_code_url}src/{filename}.py"
     elif "core" in filename:
         return f"{code_url}src/ezmsg/core/__init__.py"
     else:

docs/source/developer.rst

@@ -0,0 +1,12 @@
+Developer Info
+==============
+
+ezmsg developers will want to clone this repo locally then create an env with dependencies using `poetry install`.
+
+Documentation
+-------------
+
+Documentation is built using Sphinx.
+
+`poetry install --with docs`
+`poetry run docs/make html`

docs/source/index.rst

@@ -28,3 +28,4 @@ Contents
    utils
    other
    extensions
+   developer