Metadata-Version: 2.4
Name: zrxp
Version: 2.1.0
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU Library or Lesser General Public License (LGPL)
Classifier: Programming Language :: Rust
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Dist: pandas
Requires-Dist: polars>=0.19
Requires-Dist: pyarrow
Requires-Dist: pydantic
Requires-Dist: tzdata>=2022.7
Requires-Dist: mypy ; extra == 'mypy'
Requires-Dist: pandas-stubs ; extra == 'mypy'
Requires-Dist: pytest ; extra == 'mypy'
Requires-Dist: pytest ; extra == 'test'
Provides-Extra: mypy
Provides-Extra: test
License-File: LICENSE
Summary: ZRXP File Reader and Writer
Keywords: kisters,zrxp,time series,time,series
Author-email: Johannes Uttecht <johannes.uttecht@kisters.de>
License: LGPL
Requires-Python: >=3.9
Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
Project-URL: Homepage, https://gitlab.com/kisters/time-series/zrxp
Project-URL: Repository, https://gitlab.com/kisters/time-series/zrxp.git

# ZRXP

A library to read and write [ZRXP](https://help-water-review.kisters.de/zrxp2_3/en_gb/) time series files.

## Installation

```
pip install zrxp
```

## Usage

```python
import zrxp

# Read (returns list of ZRXPData blocks)
blocks = zrxp.read("measurements.zrxp")
blocks[0].metadata  # ZRXPMetadata (pydantic model)
blocks[0].layout    # e.g. ["timestamp", "value", "status"]
blocks[0].data      # pandas DataFrame (default) or polars DataFrame

# Read with polars engine
blocks = zrxp.read("measurements.zrxp", engine="polars")

# Write to file
zrxp.write("output.zrxp", [b.data for b in blocks], [b.metadata for b in blocks])

# Write to string
text = zrxp.writes([b.data for b in blocks], [b.metadata for b in blocks])
```

## License

LGPL-2.1-or-later

