Metadata-Version: 2.1
Name: calc-api-hs
Version: 1.0
Summary: My First API- Calculator
Home-page: https://apimatic.io
Author: APIMatic SDK Generator
Author-email: support@apimatic.io
License: UNKNOWN
Description: 
        # Getting Started with First API Calculator
        
        ## Introduction
        
        My First API- Calculator
        
        ## Install the Package
        
        The package is compatible with Python versions `3 >=3.7, <= 3.9`.
        Install the package from PyPi using the following pip command:
        
        ```python
        pip install calc-api-hs==1.0
        ```
        
        You can also view the package at:
        https://pypi.python.org/pypi/calc-api-hs
        
        ## Test the SDK
        
        You can test the generated SDK and the server with test cases. `unittest` is used as the testing framework and `nose` 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
        nosetests
        ```
        
        ## Initialize the API Client
        
        **_Note:_** Documentation for the client can be found [here.](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']** |
        
        The API client can be initialized as follows:
        
        ```python
        from firstapicalculator.firstapicalculator_client import FirstapicalculatorClient
        from firstapicalculator.configuration import Environment
        
        client = FirstapicalculatorClient(
            environment=Environment.PRODUCTION,)
        ```
        
        ## List of APIs
        
        * [Simple Calculator](doc/controllers/simple-calculator.md)
        
        ## Classes Documentation
        
        * [Utility Classes](doc/utility-classes.md)
        * [HttpResponse](doc/http-response.md)
        * [HttpRequest](doc/http-request.md)
        
        
Platform: UNKNOWN
Description-Content-Type: text/markdown
