Metadata-Version: 2.1
Name: python-abckpi
Version: 0.1.0
Summary: Python wrapper for the ABCKPI REST API
Home-page: https://gitlab.com/abckpi/python-abckpi/
Author: Seddik Yassine Abdelouadoud
Author-email: yassine@abckpi.com
License: The MIT License (MIT)
        =====================
        
        - Copyright © `2022` `ABCKPI`
        - Copyright © `2022` `Seddik Yassine Abdelouadoud`
        
        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.
        
Platform: UNKNOWN
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Development Status :: 3 - Alpha
Description-Content-Type: text/markdown
License-File: LICENCE.md

# python-abckpi

**Description**: python-abckpi is a library that wraps the ABCKPI REST API to allow a streamlined access to the API main functionalities
such as querying the list of indicators, retrieving data points and setting values of data points

  - **Technology stack**: Python 3, requests, pandas (optional)
  - **Status**:  Beta (0.1.0). The basic functionalities (in particular retrieving and setting data) are available.
  
## Dependencies

python-abckpi depends mainly on Python 3 (currently tested on Python 3.8) and requests. A detailed set of dependencies
is available in [requirements.txt](./ci/requirements.txt)

## Installation

Detailed installation instructions available at [INSTALL](INSTALL.md).

## Usage

To use python-abckpi, you need to the supply the credentials of an ABCKPI account to create an Instance object. The 
functionalities are then available as methods of the Instance object : 

```python
from abckpi.core import Instance
instance = Instance(username=username,
                    password=password)

indicators = instance.get_indicators()
```

The results returned as lists of dictionnaries or as Pandas objects if the pandas dependency is installed.

## Getting help

If you have questions, concerns, bug reports, etc, please file an issue in this repository's Issue Tracker.

## Open source licensing info
1. [LICENSE](LICENSE)

----

### Main contributors : 
- Seddik Yassine Abdelouadoud


