Metadata-Version: 2.4
Name: lvpyioTools
Version: 2.4.7
Summary: A set of tools to handle LabView files and data via the lvpyio library.
Author-email: SimKDT <simon.cadet79+github@proton.me>
License-Expression: MIT
Project-URL: Homepage, https://github.com/SimKDT/lvpyio-tools
Project-URL: Issues, https://github.com/SimKDT/lvpyio-tools/issues
Classifier: Programming Language :: Python :: 3.12
Requires-Python: >=3.12.3
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy
Requires-Dist: matplotlib
Requires-Dist: Pillow
Requires-Dist: lvpyio>=1.4.0
Dynamic: license-file

# lvpyio-tools

[![License](https://img.shields.io/github/license/SimKDT/lvpyio-tools?label=License)](LICENSE)
![Code Size](https://img.shields.io/github/languages/code-size/SimKDT/lvpyio-tools?label=Code%20Size)
[![PyPi Version](https://img.shields.io/pypi/v/lvpyioTools)](https://pypi.org/project/lvpyioTools/)

A collection of helper tools to manipulate lvpyio objects such as Sets by using the [lvpyio](https://pypi.org/project/lvpyio/) library.

## Installation

<details open>
<summary>PyPi</summary>

```bash
pip install lvpyioTools
```
</details>

<details>
<summary>Git</summary>

```bash
pip install git+https://github.com/SimKDT/lvpyio-tools.git
```
</details>

<details>
<summary>Local</summary>

```bash
pip install .
```
</details>

## Usage

```python
from pathlib import Path
from lvpyioTools.set import LVSet

set_file = Path("path/to/your/set.set")
with LVSet(set_file) as lv_set:
    print(lv_set)
    print(f"Number of frames: {len(lv_set)}")
    print(f"Properties: {lv_set.properties}")
```

You can find a more in-depth documentation in the folder `docs`.

## Doc (build)
```bash
make html
```

Serving the documentation locally:
```bash
make serve
```

## License
See [LICENSE](LICENSE) for details.
