pykuda 0.0.2

A python package that simplifies using the Kuda Bank Api

PyKuda

A python package that simplifies using the Kuda Bank Api. While the Kuda Bank Api is quite easy to use, this python package makes it seamless and easy to enjoy Kuda beautiful Open Api. PyKuda uses Kuda's Api v2 two which uses an API key and Token for authentication.

Getting started

Install PyKuda

To use this package, use the package manage pip to install PyKuda.

pip install pykuda

PyKuda has some dependencies which will be installed (requests and python-dotenv). requests is used by PyKuda to make http requests to Kuda's endpoints, while the python-dotenv is responsible for getting the environmental variables which has to be set for the requests to be authenticated; more to be discussed below.

Create Environmental variables

After installation, the next thing is to create .env file where the environmental variables will be stored. Five variables are to be set in the .env file, and they are shown in an example below.

KUDA_KEY="Your Kuda Api Key"
TOKEN_URL="Kuda API v2 Get Token endpoint"
REQUEST_URL="Kuda API v2 Endpoint"
EMAIL="Your email used to register for the Kuda account"
MAIN_ACCOUNT_NUMBER="Your main Kuda account number"

NB: Please make sure you do not push your .env file to public repositories as the details here are confidential.

Use PyKuda

It is now time to use PyKuda.

from pykuda.pykuda import PyKuda

kuda = PyKuda()
response = kuda.get_bank_list()

# response contains PyKudaResponse which has the status code and data.

Understanding PyKudaResponse

Every request made using Python is filtered and a PyKudaResponse is returned, this response has two attributes, status_code and data.

Successful request

Using the response above as an example;

>>> response
>>> PyKudaResponse(status_code=200, data=[list_of_banks])

As seen above, the PyKudaResponse returns the status_code and data, the data is an already filtered data of what you should expect as a response.

Failed request

Incase the request wasn't successful, the PyKudaResponse will be different. The data will be a rRsponse Object which you can check to investigate the cause (Maybe your Token is not correct, or the URL, or something else.). Now, let's say the API Key in the .env file was not a correct one and a request was made, the code below shows the response to expect.

>>> response
>>> PyKudaResponse(status_code=401, data=<Response [401]>)
>>>
>>> respose.data.reason # 'Invalid Credentials'
>>> respose.data.reason # 'Unauthorized'

What else can PyKuda do?

PyKuda can be used to make other requests also, if you would like to learn more about how to use PyKuda to make other requests, please check the source code. Hopefully, I would be able to improve this documentation to show examples of how it can be used to make other requests. A list of request PyKuda can make are listed below.

BANK_LIST, ADMIN_CREATE_VIRTUAL_ACCOUNT, RETRIEVE_VIRTUAL_ACCOUNT_BALANCE, ADMIN_RETRIEVE_MAIN_ACCOUNT_BALANCE, FUND_VIRTUAL_ACCOUNT, WITHDRAW_VIRTUAL_ACCOUNT, NAME_ENQUIRY, SINGLE_FUND_TRANSFER, and VIRTUAL_ACCOUNT_FUND_TRANSFER.

Please refer to the Kuda's Documentation to read more about these requests.

Acknowledgement and Improvements

This project is maintained by myself, just in case you are interested in improving this package, discovered some bugs, or would like to support in any other way, please email me. Thank you.