Metadata-Version: 2.1
Name: sierraecg
Version: 0.4.0
Summary: Sierra ECG Tools for Python
Home-page: https://github.com/sixlettervariables/sierra-ecg-tools
Author: 
Author-email: Christopher Watford <christopher.watford@gmail.com>
License: Copyright (c) 2022 Christopher Watford <christopher.watford@gmail.com>
        
        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.
        
Project-URL: Homepage, https://github.com/sixlettervariables/sierra-ecg-tools
Keywords: ecg,sierraecg,xml
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE.txt
Requires-Dist: defusedxml
Requires-Dist: numpy
Provides-Extra: dev
Requires-Dist: tox; extra == "dev"
Requires-Dist: pytest; extra == "dev"
Requires-Dist: pytest-cov; extra == "dev"
Requires-Dist: mypy; extra == "dev"
Requires-Dist: flake8; extra == "dev"
Requires-Dist: flake8-bugbear; extra == "dev"
Requires-Dist: flake8-broken-line; extra == "dev"
Requires-Dist: flake8-comprehensions; extra == "dev"
Requires-Dist: pep8-naming; extra == "dev"
Requires-Dist: black; extra == "dev"
Requires-Dist: isort; extra == "dev"
Requires-Dist: pip-tools; extra == "dev"
Requires-Dist: bumpver; extra == "dev"
Requires-Dist: mkdocs-material; extra == "dev"
Requires-Dist: mkdocs-htmlproofer-plugin; extra == "dev"
Requires-Dist: mkdocstrings[python]; extra == "dev"
Requires-Dist: mkdocs-gen-files; extra == "dev"
Requires-Dist: mkdocs-literate-nav; extra == "dev"

# sierra-ecg-tools

Sierra ECG Tools for Python.

# Requirements

Python 3.9+.

## Runtime Dependencies

- defusedxml
- numpy

# Example
```python
from sierraecg import read_file

# 12-Lead Data
f = read_file('path/to/file.xml')
for lead in f.leads:
    print(f"{lead.label}: dur={lead.duration} f={lead.sampling_freq} {lead.samples[0:8]}...")

# 12-Lead Data + Representative Beats
f = read_file('path/to/file.xml', include_repbeats=True)
for repbeat in f.repbeats:
    print(f"{repbeat.label}: dur={repbeat.duration} f={repbeat.sampling_freq} {repbeat.samples[0:8]}...")
```
