Rename examples to cli (#118)

* Not necessary since Python 3.3

* Update ruff-action repo

* Rename to cli and enforce 88 chars

* Remove trailing whitespace

* Add changelog entry

.github/workflows/test.yml

@@ -8,10 +8,10 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v4
-    - uses: chartboost/ruff-action@v1
-    - uses: chartboost/ruff-action@v1
+    - uses: astral-sh/ruff-action@v1
+    - uses: astral-sh/ruff-action@v1
       with:
-        args: 'format --check'
+        args: "format --check"
 
   test:
     needs: style

CHANGELOG.md

@@ -2,6 +2,9 @@
 ### Fixed
 - Expose detected segment (used in dejittering) as `stream["info"]["segments"]` ([#117](https://github.com/xdf-modules/pyxdf/pull/117) by [Robert Guggenberger](https://github.com/agricolab))
 
+### Changed
+- Rename `pyxdf.examples` module to `pyxdf.cli` ([#118](https://github.com/xdf-modules/xdf-Python/pull/118) by [Clemens Brunner](https://github.com/cbrnr))
+
 ## [1.16.8] - 2024-07-18
 ### Fixed
 - Fix reading numeric array data on big-endian hosts ([#98](https://github.com/xdf-modules/pyxdf/pull/98) by [Ben Beasley](https://github.com/musicinmybrain))

README.md

@@ -37,12 +37,12 @@ plt.show()
 
 ## CLI examples
 
-`pyxdf` has an `examples` module, which can be run from the command line for basic functionality.
+`pyxdf` has a `cli` module with the following basic command line tools:
 
-* `print_metadata` will enable a DEBUG logger to log read messages, then it will print basic metadata about each found stream.
-    * `python -m pyxdf.examples.print_metadata -f=/path/to/my.xdf`
+* `print_metadata` will enable a DEBUG logger to log read messages, then it will print basic metadata for each found stream.
+    * `python -m pyxdf.cli.print_metadata -f=/path/to/my.xdf`
 * `playback_lsl` will open an XDF file then replay its data in an infinite loop, but using current timestamps. This is useful for prototyping online processing.
-    * `python -m pyxdf.examples.playback_lsl /path/to/my.xdf` 
+    * `python -m pyxdf.cli.playback_lsl /path/to/my.xdf` 
 
 ## Installation
 

pyxdf/examples/playback_lsl.py → pyxdf/cli/playback_lsl.py

@@ -62,10 +62,10 @@ def __init__(
     ):
         if rate != 1.0:
             print(
-                "WARNING!! rate != 1.0; It is impossible to synchronize playback streams "
-                "with real time streams."
+                "WARNING!! rate != 1.0; it is impossible to synchronize playback "
+                "streams with real time streams."
             )
-        self.rate: float = rate  # Maximum rate is loop_time / avg_update_interval, whatever that might be.
+        self.rate: float = rate  # Maximum rate is loop_time / avg_update_interval
         self._boundary = loop_time
         self._max_srate = max_sample_rate
         decr = (1 / self._max_srate) if self._max_srate else 2 * sys.float_info.epsilon
@@ -89,7 +89,7 @@ def reset(self, reset_file_position: bool = False) -> None:
     def set_rate(self, rate: float) -> None:
         self.rate = rate
         # Note: We do not update file_read_s and prev_file_read_s.
-        #  Changing the playback rate does not change where we are in the file.
+        # Changing the playback rate does not change where we are in the file.
         self.reset(reset_file_position=False)
 
     def update(self):
@@ -121,7 +121,8 @@ def sleep(self, duration: Optional[float] = None) -> None:
             if self._max_srate <= 0:
                 duration = 0.005
             else:
-                # Check to see if the current time is not already beyond the expected time of the next iteration.
+                # Check to see if the current time is not already beyond the expected
+                # time of the next iteration.
                 step_time = 1 / self._max_srate
                 now_read_s = self.rate * (pylsl.local_clock() - self._wall_start)
                 next_read_s = self._file_read_s + step_time

pyxdf/examples/print_metadata.py → pyxdf/cli/print_metadata.py

@@ -16,7 +16,10 @@ def main(fname: str):
 
     print("Found {} streams:".format(len(streams)))
     for ix, stream in enumerate(streams):
-        msg = "Stream {}: {} - type {} - uid {} - shape {} in {} segments at {} (effective {}) Hz"
+        msg = (
+            "Stream {}: {} - type {} - uid {} - shape {} in {} segments at {} "
+            "(effective {}) Hz"
+        )
         print(
             msg.format(
                 ix + 1,