Metadata-Version: 2.1
Name: mlaide
Version: 0.1.0a1
Summary: 
Home-page: https://mlaide-ai.web.app/home
License: Apache-2.0
Author: Raman Singh
Author-email: mail.raman.s@gmail.com
Maintainer: Raman Singh
Maintainer-email: mail.raman.s@gmail.com
Requires-Python: >=3.7,<4
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Requires-Dist: cloudpickle (>=1.6.0,<2.0.0)
Requires-Dist: dataclasses-json (>=0.5.2,<0.6.0)
Requires-Dist: httpx (>=0.16.1,<0.17.0)
Requires-Dist: marshmallow (>=3.10.0,<4.0.0)
Requires-Dist: python-dateutil (>=2.8.1,<3.0.0)
Project-URL: Documentation, https://mlaide.github.io/docs/
Project-URL: Repository, https://github.com/MLAide/python-client
Description-Content-Type: text/markdown

# Python Client Library for ML Aide
[![CI pipeline](https://github.com/MLAide/python-client/actions/workflows/ci-pipeline.yml/badge.svg)](https://github.com/MLAide/python-client/actions/workflows/ci-pipeline.yml) [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=MLAide_python-client&metric=alert_status)](https://sonarcloud.io/dashboard?id=MLAide_python-client)

## Run example scripts
In `examples/` you can find some python scripts as an example.
The shell scripts can be used for easier usage.

Run the following commands once in a terminal session
```shell script
cs/
source ./set_api_key.sh
```

After that you can use the following command to run the scripts
over and over again:
```shell script
./run_example.sh
```

## Contribution
### Prerequisites
1. Install [Python](https://www.python.org/)
2. Install [Python Poetry](https://python-poetry.org/docs/#installation)
3. Optional - Install IDE: [PyCharm](https://www.jetbrains.com/pycharm/) 
or [Visual Studio Code](https://code.visualstudio.com/)

### Setup Environment
1. Install environment and download dependencies
    ```shell
   poetry install
   ```
   
2. Activate environment
    ```shell
    poetry shell
    ```

### Run Tests
```
pytest
```

### Run Tests with Coverage
```
coverage run --branch --source mlaide -m pytest
coverage html
```

### Build
```
poetry build
```

### Install
To install the package in the local environment in editable mode 
use the following command:
```
pipenv install -e .
```
