semvec/pypi-packages huggingface dataset:
demo-1-sdk 1.1.0
An APIMatic demo
Requires Python: >=3.7
Keywords: API,Petstore,SDK


# Getting Started with Petstore

## Introduction

The API enables users to view detailed information about a specific pet store and its available pets. The API can be used by pet owners, pet adoption agencies, and anyone looking for information about pets in a particular area.

## 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 demo-1-sdk==1.1.0
```

You can also view the package at:
https://pypi.python.org/pypi/demo-1-sdk/1.1.0

## 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://www.github.com/SidneyAllen/demo-1-python-sdk/tree/1.1.0/doc/client.md)

The following parameters are configurable for the API Client:

| Parameter | Type | Description |
|  --- | --- | --- |
| `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']** |
| `access_token` | `str` | The OAuth 2.0 Access Token to use for API requests. |

The API client can be initialized as follows:

```python
from petstore.petstore_client import PetstoreClient
from petstore.configuration import Environment

client = PetstoreClient(
    access_token='AccessToken',
    environment=Environment.PRODUCTION
)
```

## Authorization

This API uses `OAuth 2 Bearer token`.

## List of APIs

* [Pets](https://www.github.com/SidneyAllen/demo-1-python-sdk/tree/1.1.0/doc/controllers/pets.md)

## Classes Documentation

* [Utility Classes](https://www.github.com/SidneyAllen/demo-1-python-sdk/tree/1.1.0/doc/utility-classes.md)
* [HttpResponse](https://www.github.com/SidneyAllen/demo-1-python-sdk/tree/1.1.0/doc/http-response.md)
* [HttpRequest](https://www.github.com/SidneyAllen/demo-1-python-sdk/tree/1.1.0/doc/http-request.md)