PyPI - biosignal-device-interface - Versions diffs - 0.2.3__tar.gz → 0.2.4__tar.gz - Mend

biosignal-device-interface 0.2.3tar.gz → 0.2.4tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (47) hide show

{biosignal_device_interface-0.2.3 → biosignal_device_interface-0.2.4}/PKG-INFO RENAMED Viewed

@@ -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.4/README.md ADDED Viewed

@@ -0,0 +1,112 @@
+# Biosignal-Device-Interface
+<!-- PROJECT LOGO -->
+<br />
+<div align="center">
+  <a href="https://github.com/NsquaredLab/Biosignal-Device-Interface">
+    <img src="images/logo.png" alt="Logo" width="80" height="80">
+  </a>
+<h3 align="center">Biosignal Device Interface</h3>
+  <p align="center">
+    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>
+<!-- TABLE OF CONTENTS -->
+<details>
+  <summary>Table of Contents</summary>
+  <ol>
+    <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>
+      </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>
+## About 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.
+## Supported Devices
+### 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
+### Installation
+Install from PyPI:
+```bash
+pip install biosignal-device-interface
+```
+Or with Poetry:
+```bash
+poetry add biosignal-device-interface
+```
+### Development Installation
+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. 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/).
+<br>
+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 → biosignal_device_interface-0.2.4}/pyproject.toml RENAMED Viewed

@@ -1,9 +1,9 @@
 [tool.poetry]
 name = "biosignal-device-interface"
-version = "0.2.3"
+version = "0.2.4"
 description = "Python communication interface to many biosignal devices manufactured by several companies to easy integration in custom PySide6 applications."
 authors = ["Dominik I. Braun <dome.braun@fau.de>", "Raul C. Sîmpetru <raul.simpetru@fau.de>"]
-license = "CC BY-SA 4.0"
+license = "GPL-3.0"
 readme = "README.md"
 [tool.poetry.dependencies]

biosignal_device_interface-0.2.3/README.md DELETED Viewed

@@ -1,104 +0,0 @@
-# Biosignal-Device-Interface
-<!-- PROJECT LOGO -->
-<br />
-<div align="center">
-  <a href="https://github.com/NsquaredLab/Biosignal-Device-Interface">
-    <img src="images/logo.png" alt="Logo" width="80" height="80">
-  </a>
-<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.
-    <br />
-    <a href="https://nsquaredlab.github.io/Biosignal-Device-Interface/"><strong>Explore the docs »</strong></a>
-  </p>
-</div>
-<!-- TABLE OF CONTENTS -->
-<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="#getting-started">Getting Started</a>
-      <ul>
-        <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="#acknowledgments">Acknowledgments</a></li>
-  </ol>
-</details>
-## About The Project
-Give a brief introduction into the project.
-<!-- CONTACT -->
-### Contact
- [Dominik I. Braun](https://www.nsquared.tf.fau.de/person/dominik-braun/) - dome.braun@fau.de
-Project Link: [https://github.com/NsquaredLab/Biosignal-Device-Interface](https://github.com/NsquaredLab/Biosignal-Device-Interface)
-<!-- 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
-```
-Then, you can install the dependencies in your work area using the following command:
-```bash
-poetry install
-```
-### Development installation
-If you want to contribute to the project, you can install the development dependencies using the following command:
-```bash
-poetry install --with dev,docs
-```
-### Package Installation
-Poetry
-```Bash
-poetry add git+https://github.com/NsquaredLab/Biosignal-Device-Interface.git
-```
-PIP
-```sh
-pip install git+https://github.com/NsquaredLab/Biosignal-Device-Interface.git
-```
-<!-- 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.
-<!-- ACKNOWLEDGMENTS -->
-## Acknowledgments
-* 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.
-<p align="right">(<a href="#readme-top">back to top</a>)</p>