Feature/bus registration (#14)

* Add methods to connect buses.
* Use sets instead of lists for internal storage of collections.
* Add tests and documentation.

Author: DustinMoriarty

.flake8

@@ -6,6 +6,25 @@ on:
     branches:
       - "*"
 jobs:
+  code-style:
+    name: code-style
+    runs-on: ubuntu-latest
+    steps:
+      - name: Set up Python 3.10
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.10"
+      - name: install poetry
+        run: |
+          curl -sSL https://install.python-poetry.org | python - -y
+      - name: checkout code
+        uses: actions/checkout@v2
+      - name: install package
+        run: poetry install
+      - name: ruff check
+        run: poetry run ruff check
+      - name: ruff format
+        run: poetry run ruff format --check
   unit-test:
     name: unit test
     runs-on: ubuntu-latest
@@ -21,11 +40,9 @@ jobs:
       uses: actions/checkout@v2
     - name: install package
       run: poetry install
+    - name: ruff check
+      run: poetry run ruff check
+    - name: ruff format
+      run: poetry run ruff format --check
     - name: pytest
-      run: poetry run pytest
-    - name: black
-      run: poetry run black --check .
-    - name: isort
-      run: poetry run isort -c .
-    - name: flake8
-      run: poetry run flake8
+      run: poetry run pytest

.github/workflows/test.yml

@@ -144,4 +144,51 @@ async def main():
     async with BUS:
         await asyncio.sleep(5)
 asyncio.run(main())
-```
+```
+
+## Buses Across Multiple Modules
+Most practical use of asyncio-signal-bus involve publishers and subscribers across 
+multiple modules or files. In order to connect buses across modules we make a bus in 
+each file.
+
+```python
+# my_app/module_1.py
+from asyncio_signal_bus import SignalBus
+
+BUS_1 = SignalBus()
+
+@BUS_1.publisher(topic_name="foo")
+async def foo_publisher(arg: str):
+    signal = {"message": arg}
+    return signal
+```
+
+```python
+# my_app/module_2.py
+from asyncio_signal_bus import SignalBus
+import json
+
+BUS_2 = SignalBus()
+
+@BUS_2.subscriber(topic_name="foo")
+async def foo_subscriber_0(signal: dict):
+    print(f"foo subscriber 0 received {json.dumps(signal)}")
+```
+
+Now we connect all buses in a parent bus. All buses will now function as a single bus.
+
+```python
+# my_app/__main__.py
+import asyncio
+from asyncio_signal_bus import SignalBus
+from my_app.module_1 import BUS_1, foo_publisher
+from my_app.module_2 import BUS_2
+
+PARENT_BUS = SignalBus()
+PARENT_BUS.connect(BUS_1, BUS_2)
+
+async def main():
+    inputs = [f"message:{i}" for i in range(10)]
+    async with PARENT_BUS:
+        await asyncio.gather(*[foo_publisher(x) for x in inputs])
+```