bivital 0.1.2__tar.gz

bivital-0.1.2/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Kevin Penner, Felix Wittenfeld, Noah Greis, University Bielefeld
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

bivital-0.1.2/PKG-INFO

@@ -0,0 +1,98 @@
+Metadata-Version: 2.4
+Name: bivital
+Version: 0.1.2
+Summary: BiVital Library
+Author-email: University Bielefeld <ks-bivital-support@techfak.uni-bielefeld.de>
+License: MIT
+Project-URL: Homepage, https://bivital.eu/
+Project-URL: Repository, https://gitlab.ub.uni-bielefeld.de/bi-vital-open-source/py_bivital.git
+Project-URL: Issues, https://gitlab.ub.uni-bielefeld.de/bi-vital-open-source/py_bivital/-/issues
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pandas<3.0,>=2.2
+Requires-Dist: pyserial<4.0,>=3.5
+Requires-Dist: matplotlib<4.0,>=3.10
+Provides-Extra: notebook
+Requires-Dist: jupyterlab<5,>=4; extra == "notebook"
+Requires-Dist: ipykernel>=6; extra == "notebook"
+Dynamic: license-file
+
+# py_bivital
+
+**py_bivital** is the official Python library for the BiVital data workflow.  
+It helps you organize, preprocess and manage measurement projects, series, and raw data collected via BiVital systems.
+
+---
+
+## 🚀 Features
+
+- Project structure setup
+- Series and data import
+- Label management
+- CLI tool (`bvtool`) for fast interaction
+- Ready for Jupyter workflows and pipeline processing
+
+---
+
+## 📦 Installation
+
+> ✅ **Recommended Python version: 3.11/3.12**  
+> Other versions (e.g. 3.13) might cause compatibility issues with some dependencies like `pyarrow`.
+
+### 1. Create and activate a virtual environment (recommended)
+
+#### 🔹 Option A: Using `venv` (standard Python virtual environment)
+
+Open a terminal and navigate to your project directory:
+```
+cd path/to/your/project
+```
+Then create and activate your virtual environment:
+```bash
+pip install virtualenv                     # If virtualenv is not installed
+python -m venv <env>                       # Make sure Python 3.11/3.12 is installed
+source <env>/bin/activate                  # On Linux/Mac
+<env>\Scripts\activate                     # On Windows
+```
+
+#### 🔹 Option B: Using conda
+```bash
+conda create -n <env> python=3.12
+conda activate <env>
+conda install pip
+```
+
+### 2. Install via pip
+```bash
+pip install git+https://gitlab.ub.uni-bielefeld.de/bi-vital-open-source/py_bivital
+```
+---
+
+## 🛠 Usage
+### Command-Line Interface (CLI)
+```bash
+bvtool -h                     # Show help
+bvtool project -p PATH -n NAME
+bvtool series -p PATH -n NAME
+bvtool data -p PATH -s pc
+bvtool label -p PATH
+````
+---
+## 📂 Project Structure
+Your project will be organized like this:
+```
+BiVitalProject/
+├── Series1/
+│   └── MAC_01/
+│       └── log_01.csv
+└── Series2/
+    └── ...
+```

bivital-0.1.2/README.md

@@ -0,0 +1,71 @@
+# py_bivital
+
+**py_bivital** is the official Python library for the BiVital data workflow.  
+It helps you organize, preprocess and manage measurement projects, series, and raw data collected via BiVital systems.
+
+---
+
+## 🚀 Features
+
+- Project structure setup
+- Series and data import
+- Label management
+- CLI tool (`bvtool`) for fast interaction
+- Ready for Jupyter workflows and pipeline processing
+
+---
+
+## 📦 Installation
+
+> ✅ **Recommended Python version: 3.11/3.12**  
+> Other versions (e.g. 3.13) might cause compatibility issues with some dependencies like `pyarrow`.
+
+### 1. Create and activate a virtual environment (recommended)
+
+#### 🔹 Option A: Using `venv` (standard Python virtual environment)
+
+Open a terminal and navigate to your project directory:
+```
+cd path/to/your/project
+```
+Then create and activate your virtual environment:
+```bash
+pip install virtualenv                     # If virtualenv is not installed
+python -m venv <env>                       # Make sure Python 3.11/3.12 is installed
+source <env>/bin/activate                  # On Linux/Mac
+<env>\Scripts\activate                     # On Windows
+```
+
+#### 🔹 Option B: Using conda
+```bash
+conda create -n <env> python=3.12
+conda activate <env>
+conda install pip
+```
+
+### 2. Install via pip
+```bash
+pip install git+https://gitlab.ub.uni-bielefeld.de/bi-vital-open-source/py_bivital
+```
+---
+
+## 🛠 Usage
+### Command-Line Interface (CLI)
+```bash
+bvtool -h                     # Show help
+bvtool project -p PATH -n NAME
+bvtool series -p PATH -n NAME
+bvtool data -p PATH -s pc
+bvtool label -p PATH
+````
+---
+## 📂 Project Structure
+Your project will be organized like this:
+```
+BiVitalProject/
+├── Series1/
+│   └── MAC_01/
+│       └── log_01.csv
+└── Series2/
+    └── ...
+```

bivital-0.1.2/pyproject.toml

@@ -0,0 +1,50 @@
+[build-system]
+requires = ["setuptools>=61.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "bivital"
+version = "0.1.2"
+description = "BiVital Library"
+authors = [{ name = "University Bielefeld", email = "ks-bivital-support@techfak.uni-bielefeld.de" }]
+readme = { file = "README.md", content-type = "text/markdown" }
+license = { text = "MIT" }
+requires-python = ">=3.10"
+dependencies = [
+  "pandas>=2.2,<3.0",
+  "pyserial>=3.5,<4.0",
+  "matplotlib>=3.10,<4.0"
+]
+classifiers = [
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3 :: Only",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "License :: OSI Approved :: MIT License",
+  "Operating System :: OS Independent"
+]
+
+[project.optional-dependencies]
+notebook = [
+  "jupyterlab>=4,<5",
+  "ipykernel>=6"
+]
+
+[project.scripts]
+bvtool = "bivital.bvtool:main"
+
+[project.urls]
+Homepage = "https://bivital.eu/"
+Repository = "https://gitlab.ub.uni-bielefeld.de/bi-vital-open-source/py_bivital.git"
+Issues = "https://gitlab.ub.uni-bielefeld.de/bi-vital-open-source/py_bivital/-/issues"
+
+[tool.setuptools]
+package-dir = { "" = "src" }
+include-package-data = true
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.setuptools.package-data]
+"bivital.examples.example_project" = ["**/*"]

bivital-0.1.2/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

bivital-0.1.2/src/bivital/bvtool.py

@@ -0,0 +1,59 @@
+from bivital import pipeline as bvp
+import argparse
+import sys
+
+def main():
+
+    #Mainparser
+    parser = argparse.ArgumentParser(description="Main parser with subcommands")
+
+    #Subparsers
+    subparsers = parser.add_subparsers(dest="subcommand", help="sub-command help --> type <argument> -h/--help")
+
+    #Project parser
+    project_parser = subparsers.add_parser("project", help="Project help")
+    project_parser.add_argument("-p", "--path", help="type the path, Default: choose from file explorer")
+    project_parser.add_argument("-n", "--name", help="the name of the Project or Series")
+
+    #Series parser
+    series_parser = subparsers.add_parser("series", help="Series help")
+    series_parser.add_argument("-p", "--path", help="type the path, Default: choose from file explorer")
+    series_parser.add_argument("-n", "--name", help="the name of the Project or Series")
+
+    #Data parser
+    data_parser = subparsers.add_parser("data", help="Data help")
+    data_parser.add_argument("-p", "--path", help="type the path, Default: choose from file explorer")
+    data_parser.add_argument("-s", "--source", help="PC or BiVital as Data sources, Default: ask for source", choices=['pc', 'bivital'], type=str.casefold)
+
+    #Label parser
+    label_parser = subparsers.add_parser("label", help="Label help")
+    label_parser.add_argument("-p", "--path", help="type the path, Default: choose from file explorer")
+
+    #Example parser
+    example_parser = subparsers.add_parser("example", help="Example help")
+    
+    #Accept upper- and lowercase 
+    if len(sys.argv) > 1:
+        sys.argv[1] = sys.argv[1].casefold()
+
+    args = parser.parse_args()
+
+    if args.subcommand == "project":
+        #call Project function 
+        bvp.BiVital_DataPipeline().createProject(path=args.path, name=args.name)
+    elif args.subcommand == "series":
+        #call Series function
+        bvp.BiVital_DataPipeline().add_measurement_series(path=args.path, name=args.name)
+    elif args.subcommand == "data":
+        #call Data function
+        bvp.BiVital_DataPipeline().add_data(path=args.path, source=args.source)
+    elif args.subcommand == "label":
+        #call Label function
+        bvp.BiVital_DataPipeline().add_label(path=args.path)
+    elif args.subcommand == "example":
+        #call example function
+        bvp.BiVital_DataPipeline().open_example()
+
+if __name__ == "__main__":
+    main()
+