Metadata-Version: 2.1
Name: abra-python
Version: 0.1.1
Summary: API client for ERP ABRA Gen system
License: MIT
Author: Adam Zurek
Author-email: adam.zurek@backbone.sk
Requires-Python: >=3.9,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Description-Content-Type: text/markdown

# abra-python

API client for ERP ABRA Gen system.

## Introduction

Abra-python API Client is used for creating requests to ABRA API and for receiving responses which are deserialized to objects.

## Installation

```python
# pip
pip install abra-python

# pipenv
pipenv install abra-python

# poetry
poetry add abra-python
```

## Example

To establish a successful communication with ABRA via HTTP REST methods, we need to configure and set some settings:

### Configuration

Stores information about api url, timeout and authentication-based settings like api key, secret, token, ...

```python
from abra_python.configuration import Configuration

my_configuration = Configuration(
    api_url='https://www.myapi.com/api/v1/',
    key='my-api-key',
    secret='my-secret',
    timeout=60,
    token='my-super-token'
)
```

### ApiClient initialization

After initialization of these two setting objects we need to initialize api_client.

```python
from abra_python.api_client import ApiClient

my_api_client = ApiClient(configuration=my_configuration)
```

Or with login credentials, if needed:

```python
from abra_python.api_client import ApiClient

ApiClient.create_from_auth(
    configuration=my_configuration,
    username='test@envidom.sk',
    password='1234'
)
```

### Usage
to be continued...

---
Developed with 💙 and ☕️ by [BACKBONE s.r.o.](https://www.backbone.sk/), 2023 (C)

