Metadata-Version: 2.1
Name: analyser
Version: 0.1.0
Summary: An analytical library for signal data analysis
Home-page: https://github.com/calevdw/Analyser
Author: Cale van der Westhuizen
Author-email: cale@tks.co.za
License: UNKNOWN
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Requires-Dist: numpy
Requires-Dist: requests
Requires-Dist: requests-mock

# Analyser v1.0

The analyser Python package is designed to fetch and analyze signal data. It interfaces with a web API to retrieve signals and their values, offering functionalities to calculate statistical measures like mean and standard deviation. It supports filtering by groups, ensuring tailored analyses. The package also includes efficient data handling with batch retrieval, making it suitable for large datasets.

## Environment setup
Create virtual environment with Python version > 3.8.5
```
python3 -m venv .venv
```
## Activate virtual environment
```
source .venv/bin/activate
```
## Install requirements
```
pip install -r requirements.txt
```
## Run all Tests
```
pytest -v -s
```

## Useage
(Refer to unseage.md)

## Installation
(Refer to installation.md)

