Metadata-Version: 2.1
Name: python-apimatic-calculator
Version: 1.0.899
Summary: Simple calculator API hosted on APIMATIC
Author-email: mrafnadeem <muhammad.nadeem@apimatic.io>
Requires-Python: >=3.7
Description-Content-Type: text/markdown
Provides-Extra: testutils
License-File: LICENSE


# Getting Started with APIMATIC Calculator

## Introduction

Simple calculator API hosted on APIMATIC

## Install the Package

The package is compatible with Python versions `3 >=3.7, <= 3.11`.
Install the package from PyPi using the following pip command:

```python
pip install myUniquePythonPackageName==1.0.899
```

You can also view the package at:
https://pypi.python.org/pypi/myUniquePythonPackageName/1.0.899

## Test the SDK

You can test the generated SDK and the server with test cases. `unittest` is used as the testing framework and `pytest` is used as the test runner. You can run the tests as follows:

Navigate to the root directory of the SDK and run the following commands

```
pip install -r test-requirements.txt
pytest
```

## Initialize the API Client

**_Note:_** Documentation for the client can be found [here.](https://github.com/apimatic/calculator-sdk/blob/0e65eb4/doc/client.md)

The following parameters are configurable for the API Client:

| Parameter | Type | Description |
|  --- | --- | --- |
| `environment` | Environment | The API environment. <br> **Default: `Environment.PRODUCTION`** |
| `http_client_instance` | `HttpClient` | The Http Client passed from the sdk user for making requests |
| `override_http_client_configuration` | `bool` | The value which determines to override properties of the passed Http Client from the sdk user |
| `http_call_back` | `HttpCallBack` | The callback value that is invoked before and after an HTTP call is made to an endpoint |
| `timeout` | `float` | The value to use for connection timeout. <br> **Default: 60** |
| `max_retries` | `int` | The number of times to retry an endpoint call if it fails. <br> **Default: 0** |
| `backoff_factor` | `float` | A backoff factor to apply between attempts after the second try. <br> **Default: 2** |
| `retry_statuses` | `Array of int` | The http statuses on which retry is to be done. <br> **Default: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524]** |
| `retry_methods` | `Array of string` | The http methods on which retry is to be done. <br> **Default: ['GET', 'PUT']** |

The API client can be initialized as follows:

```python
from apimaticcalculator.apimaticcalculator_client import ApimaticcalculatorClient
from apimaticcalculator.configuration import Environment

client = ApimaticcalculatorClient()
```

## List of APIs

* [Simple Calculator](https://github.com/apimatic/calculator-sdk/blob/0e65eb4/doc/controllers/simple-calculator.md)

## Classes Documentation

* [Utility Classes](https://github.com/apimatic/calculator-sdk/blob/0e65eb4/doc/utility-classes.md)
* [HttpResponse](https://github.com/apimatic/calculator-sdk/blob/0e65eb4/doc/http-response.md)
* [HttpRequest](https://github.com/apimatic/calculator-sdk/blob/0e65eb4/doc/http-request.md)

