Merge branch 'demo' into testing

README.md

@@ -47,17 +47,14 @@ A complete demo of `tqdm_publisher` can be found in the `demo` directory, which
 
 To run the demo, first install the dependencies:
 ```bash
-pip install -r demo/requirements.txt
+pip install tqdm_publisher[demo]
 ```
 
-Then, run the Python script for the demo:
+Then, run the base CLI command to start the demo server and client:
 ```bash
-python demo/main.py
+tqdm_publisher demo
 ```
 
-Finally, open the demo web page in your browser:
-```bash
-open demo/index.html
-```
+> **Note:** Alternatively, you can run each part of the demo separately by running `tqdm_publisher demo --server` and `tqdm_publisher demo --client` in separate terminals.
 
-You can then click the Create Progress Bar button to create a new `TQDMPublisher` instance, which will begin updating based on the `TQDMPublisher` instance in the Python script.
+Finally, you can click the Create Progress Bar button to create a new `TQDMPublisher` instance, which will begin updating based on the `TQDMPublisher` instance in the Python script.

cli.py

@@ -0,0 +1,37 @@
+import subprocess
+import sys
+from pathlib import Path
+
+demo_base_path = Path(__file__).parent / "demo"
+
+client_path = demo_base_path / "client.html"
+server_path = demo_base_path/ "server.py"
+
+def main():
+
+    command = sys.argv[1]
+    flags_list = sys.argv[2:]
+
+    client_flag = "--client" in flags_list
+    server_flag = "--server" in flags_list
+    both_flags = "--server" in flags_list and "--client" in flags_list
+
+    flags = dict(
+        client = not server_flag or both_flags,
+        server = not client_flag or both_flags,
+
+    )
+
+    if (command == "demo"):
+        if flags["client"]:
+            subprocess.run(["open", client_path])
+
+        if flags["server"]:
+            subprocess.run(["python", server_path])
+
+    else:
+        print(f"{command} is an invalid command.")
+
+
+if __name__ == "__main__":
+    main()

demo/client.py

@@ -0,0 +1,11 @@
+import subprocess
+
+from pathlib import Path
+
+client_path = Path(__file__).parent / "client.html"
+
+def main():
+    subprocess.run(["open", client_path])
+
+if __name__ == "__main__":
+    main()

pyproject.toml

@@ -2,6 +2,9 @@
 requires = ["hatchling", "hatch-vcs"]
 build-backend = "hatchling.build"
 
+[tool.hatch.version]
+source = "vcs"
+
 [project]
 name = "tqdm_publisher"
 version="0.1.0"
@@ -43,13 +46,9 @@ demo = [
     "websockets==12.0"
 ]
 
-
 [project.urls]
 "Homepage" = "https://github.com/catalystneuro/tqdm_publisher"
 "Bug Tracker" = "https://github.com/catalystneuro/tqdm_publisher/issues"
 
-[tool.hatch.version]
-source = "vcs"
-
 [project.gui-scripts]
-tqdm_publisher-demo-server = "demo.server:main"
+tqdm_publisher = "cli:main"

src/tqdm_publisher/publisher.py

@@ -11,12 +11,13 @@ def __init__(self, *args, **kwargs):
 
     # Override the update method to call callbacks 
     def update(self, n=1, always_callback=False):
-        if super().update(n) or always_callback:
+        displayed = super().update(n)
+        for id in list(self.callbacks):
+            callback = self.callbacks.get(id)
+            if callback:
+                callback(self.format_dict)
+        return displayed
 
-            for id in list(self.callbacks):
-                callback = self.callbacks.get(id)
-                if callback:
-                    callback(self.format_dict)
 
 
     # Subscribe to updates