ha-sdk-python

A Python SDK client for the api.hostafrica.com API.

This Python package is automatically generated by the OpenAPI Generator project:

Requirements.

Python 3.9+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/hostafrica/ha-sdk-python.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/hostafrica/ha-sdk-python.git)

Then import the package:

import ha_sdk_python

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import ha_sdk_python

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import ha_sdk_python
from ha_sdk_python.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.hostafrica.com
# See configuration.py for a list of all supported configuration parameters.
configuration = ha_sdk_python.Configuration(
    host = "https://api.hostafrica.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: BearerAuth
configuration = ha_sdk_python.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)


# Enter a context with an instance of the API client
with ha_sdk_python.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ha_sdk_python.BackupsApi(api_client)
    create_backup_request_content = ha_sdk_python.CreateBackupRequestContent() # CreateBackupRequestContent | 

    try:
        api_response = api_instance.create_backup(create_backup_request_content)
        print("The response of BackupsApi->create_backup:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling BackupsApi->create_backup: %s\n" % e)

Documentation

API Reference Documentation

Documentation per api/operation

Documentation For Authorization

Authentication schemes defined for the API:

BearerAuth

• Type: Bearer authentication