No project description provided
Project description
Excel Provider
This is a REST service that reads data from a EXCEL file and provides them over a REST API. It can provide a data row for each sheet configured.
It provides the following endpoints:
GET /sheets
: Get a list of all available sheets and their IDsGET /sheet/<id>
: Get the data row for this sheetPOST /refresh
: Reload the data from fileGET /spec
: Get swagger spec of API
For more information about the endpoints and their parameters, see the /spec
endpoint.
Usage
The configuration is done using a YAML file providing the following information
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
.
Docker Image
Run a Docker image providing the providing backend, for example
docker run \
-v /path/to/config:/app/config.yaml \
-v /path/to/data.xlsx:/app/data.xlsx \
-p 5000:5000 \
cybernop/excel-provider
Python Package
Start the server from the Python package providing the config
python -m excel_provider --config <config file>
Tests
pytest is used for unit tests. Run all tests from the project root.
pytest
Development
For development, install the library as editable using pip
pip install --editable .
and start from the python package.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for excel_provider-0.1.4-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 31acb69f1dc4163b2938a130d8fe952f4289374fe74163d57501816dddf97445 |
|
MD5 | cf62eb88da1dd06211244eb694f37e35 |
|
BLAKE2b-256 | b4d2a8b2a20e81b58823b71a974b240162962ae6e15bd8706598a1dfcb5772f5 |