Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Eliminate extensions; migrated to ezmsg-org. #128

Merged
merged 1 commit into from
Jun 14, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 0 additions & 41 deletions .github/workflows/python-publish-ezmsg-sigproc.yml

This file was deleted.

41 changes: 0 additions & 41 deletions .github/workflows/python-publish-ezmsg-websocket.yml

This file was deleted.

41 changes: 0 additions & 41 deletions .github/workflows/python-publish-ezmsg-zmq.yml

This file was deleted.

6 changes: 1 addition & 5 deletions .github/workflows/python-tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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: |
Expand All @@ -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
17 changes: 7 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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`
Expand Down
17 changes: 4 additions & 13 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
@@ -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
Expand Down Expand Up @@ -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):
Expand All @@ -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:
Expand Down
12 changes: 12 additions & 0 deletions docs/source/developer.rst
Original file line number Diff line number Diff line change
@@ -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`
1 change: 1 addition & 0 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -28,3 +28,4 @@ Contents
utils
other
extensions
developer
9 changes: 0 additions & 9 deletions extensions/ezmsg-sigproc/LICENSE.txt

This file was deleted.

17 changes: 0 additions & 17 deletions extensions/ezmsg-sigproc/README.md

This file was deleted.

Loading