biosignal-device-interface 0.2.3__py3-none-any.whl → 0.2.4__py3-none-any.whl

{biosignal_device_interface-0.2.3.dist-info → biosignal_device_interface-0.2.4.dist-info}/METADATA

@@ -1,13 +1,13 @@
 Metadata-Version: 2.4
 Name: biosignal-device-interface
-Version: 0.2.3
+Version: 0.2.4
 Summary: Python communication interface to many biosignal devices manufactured by several companies to easy integration in custom PySide6 applications.
-License: CC BY-SA 4.0
+License: GPL-3.0
 License-File: LICENSE
 Author: Dominik I. Braun
 Author-email: dome.braun@fau.de
 Requires-Python: >=3.10,<3.13
-Classifier: License :: Other/Proprietary License
+Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
@@ -34,10 +34,15 @@ Description-Content-Type: text/markdown
 <h3 align="center">Biosignal Device Interface</h3>
 
   <p align="center">
-    Python communication interface to many biosignal devices manufactured by several companies to easy integration in custom PySide6 applications.
+    Python communication interface to many biosignal devices manufactured by several companies for easy integration in custom PySide6 applications.
     <br />
     <a href="https://nsquaredlab.github.io/Biosignal-Device-Interface/"><strong>Explore the docs »</strong></a>
   </p>
+
+[![PyPI version](https://img.shields.io/pypi/v/biosignal-device-interface.svg)](https://pypi.org/project/biosignal-device-interface/)
+[![Python versions](https://img.shields.io/pypi/pyversions/biosignal-device-interface.svg)](https://pypi.org/project/biosignal-device-interface/)
+[![License](https://img.shields.io/badge/license-GPL--3.0-blue.svg)](LICENSE)
+
 </div>
 
 
@@ -46,19 +51,18 @@ Description-Content-Type: text/markdown
 <details>
   <summary>Table of Contents</summary>
   <ol>
-    <li>
-      <a href="#about-the-project">About The Project</a>
-    </li>
-    <li><a href="#contact">Contact</a></li>
+    <li><a href="#about-the-project">About The Project</a></li>
+    <li><a href="#supported-devices">Supported Devices</a></li>
     <li>
       <a href="#getting-started">Getting Started</a>
       <ul>
+        <li><a href="#installation">Installation</a></li>
         <li><a href="#development-installation">Development Installation</a></li>
-        <li><a href="#package-installation">Package Installation</a></li>
       </ul>
     </li>
     <li><a href="#usage">Usage</a></li>
     <li><a href="#license">License</a></li>
+    <li><a href="#contact">Contact</a></li>
     <li><a href="#acknowledgments">Acknowledgments</a></li>
   </ol>
 </details>
@@ -66,64 +70,68 @@ Description-Content-Type: text/markdown
 
 ## About The Project
 
-Give a brief introduction into the project.
+Biosignal Device Interface provides a unified Python API for communicating with biosignal acquisition devices from multiple manufacturers. It includes ready-to-use PySide6 widgets for device configuration and data streaming, making it easy to integrate biosignal acquisition into custom applications.
 
-<!-- CONTACT -->
-### Contact
-
- [Dominik I. Braun](https://www.nsquared.tf.fau.de/person/dominik-braun/) - dome.braun@fau.de
+## Supported Devices
 
-Project Link: [https://github.com/NsquaredLab/Biosignal-Device-Interface](https://github.com/NsquaredLab/Biosignal-Device-Interface)
+### OT Bioelettronica
+- **Quattrocento** - 400+ channel EMG/EEG amplifier
+- **Quattrocento Light** - Compact version of Quattrocento
+- **Muovi** - Wearable EMG sensor
+- **Muovi+** - Enhanced wearable EMG sensor
+- **SyncStation** - Multi-device synchronization hub (Muovi, Muovi+, Due+)
 
+### Other Devices
+- More devices coming soon...
 
 <!-- GETTING STARTED -->
 ## Getting Started
 
-The local set up is made using [Poetry](https://python-poetry.org/). You can install Poetry using the following command.
-Note: It is recommeded to install it globally.
-```bash
-pip install poetry
-```
+### Installation
 
-Then, you can install the dependencies in your work area using the following command:
+Install from PyPI:
 ```bash
-poetry install
+pip install biosignal-device-interface
 ```
 
-### Development installation
-If you want to contribute to the project, you can install the development dependencies using the following command:
+Or with Poetry:
 ```bash
-poetry install --with dev,docs
+poetry add biosignal-device-interface
 ```
 
-### Package Installation
-Poetry
-```Bash
-poetry add git+https://github.com/NsquaredLab/Biosignal-Device-Interface.git
-```
+### Development Installation
 
-PIP
-```sh
-pip install git+https://github.com/NsquaredLab/Biosignal-Device-Interface.git
-```
+Clone the repository and install with development dependencies:
 
+```bash
+git clone https://github.com/NsquaredLab/Biosignal-Device-Interface.git
+cd Biosignal-Device-Interface
+poetry install --with dev,docs
+```
 
 <!-- USAGE EXAMPLES -->
 ## Usage
 
 Examples of how you can use this package can be found in our [examples gallery](https://nsquaredlab.github.io/Biosignal-Device-Interface/auto_examples/index.html).
 
-
 <!-- LICENSE -->
 ## License
 
-Distributed under the GPL-3.0 license License. See `LICENSE.txt` for more information.
+Distributed under the GPL-3.0 License. See `LICENSE` for more information.
+
+<!-- CONTACT -->
+## Contact
+
+- [Dominik I. Braun](https://www.nsquared.tf.fau.de/person/dominik-braun/) - dome.braun@fau.de
+- [Raul C. Sîmpetru](https://www.nsquared.tf.fau.de/person/raul-simpetru/) - raul.simpetru@fau.de
+
+Project Link: [https://github.com/NsquaredLab/Biosignal-Device-Interface](https://github.com/NsquaredLab/Biosignal-Device-Interface)
 
 <!-- ACKNOWLEDGMENTS -->
 ## Acknowledgments
-* Find available Python and Matlab implementations of OT Bioelettronica's devices on their [website](https://otbioelettronica.it/en/download/). 
+* Find available Python and Matlab implementations of OT Bioelettronica's devices on their [website](https://otbioelettronica.it/en/download/).
 <br>
-Note: The example scripts does not provide you with the same level of utility for GUI implementations.
+Note: The example scripts do not provide you with the same level of utility for GUI implementations.
 
 <p align="right">(<a href="#readme-top">back to top</a>)</p>
 

{biosignal_device_interface-0.2.3.dist-info → biosignal_device_interface-0.2.4.dist-info}/RECORD

@@ -40,7 +40,7 @@ biosignal_device_interface/gui/ui_compiled/otb_muovi_template_widget.py,sha256=a
 biosignal_device_interface/gui/ui_compiled/otb_quattrocento_light_template_widget.py,sha256=J_neLi-Mrqoo9feKHd9SNohxbEBqJY2YW11dJG_203k,12031
 biosignal_device_interface/gui/ui_compiled/otb_quattrocento_template_widget.py,sha256=wJQCrRhGm-_Dj3y81BkCprGoTGErVlQTDS7GNdm_xDs,17439
 biosignal_device_interface/gui/ui_compiled/otb_syncstation_template_widget.py,sha256=x_-ApMy8hVU8XCBMW6DEgH2rb1Cbk_zYmjDoaFd7r-I,32457
-biosignal_device_interface-0.2.3.dist-info/METADATA,sha256=33u0EUw0TSmkhrw3dUVvbUH1A0zWdp0xCRZEbo6nQhQ,3936
-biosignal_device_interface-0.2.3.dist-info/WHEEL,sha256=kJCRJT_g0adfAJzTx2GUMmS80rTJIVHRCfG0DQgLq3o,88
-biosignal_device_interface-0.2.3.dist-info/licenses/LICENSE,sha256=zFRw_u1mGSOH8GrpOu0L1P765aX9fB5UpKz06mTxAos,34893
-biosignal_device_interface-0.2.3.dist-info/RECORD,,
+biosignal_device_interface-0.2.4.dist-info/METADATA,sha256=y3DYZFiPu0pOPTc6501UQfVZefwaG0RqDB3oo4r1cQA,4731
+biosignal_device_interface-0.2.4.dist-info/WHEEL,sha256=kJCRJT_g0adfAJzTx2GUMmS80rTJIVHRCfG0DQgLq3o,88
+biosignal_device_interface-0.2.4.dist-info/licenses/LICENSE,sha256=zFRw_u1mGSOH8GrpOu0L1P765aX9fB5UpKz06mTxAos,34893
+biosignal_device_interface-0.2.4.dist-info/RECORD,,