Updated README and added video

Author: felixchenier

README.md

@@ -1,10 +1,35 @@
 # kineticstoolkit_extensions
 Additional modules and development of new features for Kinetics Toolkit
 
-This repository will replace the different repositories used for the current extension system. It will also be distributed via pip and conda, like kineticstoolkit.
+This package provides modules that are not included straight into kineticstoolkit because either:
 
-It will contain features that are deemed too specific for Kinetics Toolkit, but still useful in some use cases. It will also contain half-baked new features in development. The main objective for this method is to:
+1. Their use case is specific to one research area of human movement biomechanics (e.g., pushrimkinetics)
+2. They refer to unused or older hardware (e.g., n3d)
+3. They are in active development and their API is not stable enough to be distributed in their final form
+4. They are not neutral - for example, they may relate to assumptions on the human body, such as anthropometric tables or local coordinate systems based on bony landmarks.
 
-- reach a stable 1.0 version for Kinetics Toolkit while continuing developing new features with a clear separation between misc/development/testing (kineticstoolkit_extensions) and stable (kineticstoolkit)
-- ease the installation of extensions, without adding unnecessary friction both for developers and users (i.e. maintaining multiple repositories)
-- adopt continuous integration practices (i.e. unit tests) for extensions, like for kineticstoolkit
+To install:
+
+```
+pip install kineticstoolkit_extensions
+```
+
+or
+
+```
+conda install -c conda-forge kineticstoolkit_extensions
+```
+
+The published extensions all have unit tests so that they are continually tested and expected to work in future versions of Python.
+
+
+## Stable extensions
+
+[pushrimkinetics](tutorials/pushrimkinetics.ipynb) - Allow reading and processing kinetics recorded by instrumented wheelchair wheels such as SmartWheel.
+
+n3d - Allow reading n3d file from NDI Optotrak.
+
+
+## Currently in development
+
+video - Will allow reading video files, synchronize those videos with other TimeSeries, and use the videos to add events to these TimeSeries. You need to install opencv to use this module.

kineticstoolkit_extensions/__init__.py

@@ -24,7 +24,7 @@
 
 import kineticstoolkit_extensions.n3d as n3d
 import kineticstoolkit_extensions.pushrimkinetics as pushrimkinetics
-
+import kineticstoolkit_extensions.video as video
 
 def __dir__():
     return ["n3d", "pushrimkinetics"]

kineticstoolkit_extensions/n3d.py

@@ -17,7 +17,7 @@
 
 
 """
-Provide a short description of your extension.
+Read NDI Optotrak N3D files.
 """
 
 __author__ = "Félix Chénier"
@@ -110,11 +110,7 @@ def read_n3d(filename: str, labels: Sequence[str] = []) -> TimeSeries:
     return ts
 
 
-"""
-The section below is optional. If you put code examples in your docstring,
-then running this file will test that your examples give the correct results.
-Please check https://docs.python.org/3/library/doctest.html for details.
-"""
+
 if __name__ == "__main__":  # pragma: no cover
     import doctest