Metadata-Version: 2.1
Name: excel-provider
Version: 0.1.3
Summary: 
Home-page: https://github.com/cybernop/excel-provider
License: MIT
Author: Alexander Essenwanger
Author-email: cibernop@mable-anex.de
Requires-Python: >=3.11,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Dist: flask (>=3.0.2,<4.0.0)
Requires-Dist: flask-swagger (>=0.2.14,<0.3.0)
Requires-Dist: openpyxl (>=3.1.2,<4.0.0)
Requires-Dist: pandas (>=2.2,<3.0)
Requires-Dist: pyyaml (>=6.0.1,<7.0.0)
Project-URL: Repository, https://github.com/cybernop/excel-provider
Description-Content-Type: text/markdown

# Excel Provider

[![Tests](https://github.com/cybernop/excel-provider/actions/workflows/python-app-test.yml/badge.svg)](https://github.com/cybernop/excel-provider/actions/workflows/python-app-test.yml) [![Package](https://github.com/cybernop/excel-provider/actions/workflows/python-app-package.yml/badge.svg)](https://github.com/cybernop/excel-provider/actions/workflows/python-app-package.yml) [![PYPI](https://github.com/cybernop/excel-provider/actions/workflows/python-app-publish.yml/badge.svg)](https://github.com/cybernop/excel-provider/actions/workflows/python-app-publish.yml)

## Usage

The configuration is done using a YAML file providing the following information

```yaml
server:
  host: "0.0.0.0"
  port: 5000
handler:
  excel_file: path/to/file.xlsx
  sheets:
    - "sheet 1"
    - "sheet 2"
  data_cols:
    - "column 1"
    - "column 2"
```

While `column 1` is the data column on `sheet 1` and `column 2` on `sheet 2`.

### Python Package

Start the server from the Python package providing the config

```bash
python -m excel_provider --config <config file>
```

## Tests

_pytest_ is used for unit tests. Run all tests from the project root.

```bash
pytest
```

