# Prembly Identitypass
The Python library for the Prembly Identitypass API.The Python library provides easy access to Prembly Identitypass API's from Django, Flask, and other Python apps. It abstracts the complexity involved in direct integration and allows you to make quick calls to the APIs.
## Table of Contents
- [Prembly Identitypass](#prembly-identitypass)
- [Table of Contents](#table-of-contents)
- [Install](#install)
- [Documentation](#documentation)
- [Getting Started](#getting-started)
- [Configuration](#configuration)
- [Country and Available method](#country-and-available-method)
- [Nigeria](#nigeria)
- [Ghana](#ghana)
- [Kenya](#kenya)
- [Rwanda](#rwanda)
- [Sierra Leone](#sierra-leone)
- [South Africa](#south-africa)
- [Uganda](#uganda)
- [Global](#global)
- [FACE VALIDATION](#face-validation)
- [RADAR](#radar)
- [DOCUMENT](#document)
- [Calling Endpoints](#calling-endpoints)
- [Exceptions](#exceptions)
- [MissingAuthKeyError](#missingauthkeyerror)
- [MissingRequiredDataError](#missingrequireddataerror)
- [APIConnectionError](#apiconnectionerror)
- [InvalidMethodError](#invalidmethoderror)
## Install
```console
pip install pyprembly
```
Note: This is currently under active development
## Documentation
## Getting Started
The package supports all Prembly Identitypass API endpoints for the following countries:
- Nigeria
- Kenya
- Ghana
- Sierra Leone
- South Africa
- Uganda
- Rwanda
### Configuration
To use pyprembly you will need to set the following in your environment variable
```console
PREMBLY_APP_ID="your application id"
PREMBLY_X_API_KEY="your x_app_key id"
PREMBLY_ENVIRONMENT="environment default to test"
```
Visit [Prembly](https://prembly.com/) to get both app id and x-api-key
### Country and Available method
The available method of the `DataVerification` class are as follow:
#### Nigeria
```python
from pyprembly.data.nigeria import DataVerification
```
#### Ghana
```python
from pyprembly.data.ghana import DataVerification
```
#### Kenya
```python
from pyprembly.data.kenya import DataVerification
```
#### Rwanda
```python
from pyprembly.data.rwanda import DataVerification
```
#### Sierra Leone
```python
from pyprembly.data.sierra_leone import DataVerification
```
#### South Africa
```python
from pyprembly.data.south_africa import DataVerification
```
#### Uganda
```python
from pyprembly.data.uganda import DataVerification
```
### Global
```python
from pyprembly.business import DataVerification
```
### FACE VALIDATION
```python
from pyprembly.face import DataVerification
```
### RADAR
```python
from pyprembly.radar import DataVerification
```
### DOCUMENT
```python
from pyprembly.radar import DataVerification
```
### Calling Endpoints
To make a simple API call:
```python
from pypyprembly.data.nigeria import DataVerification
try:
DataVerification().bank_account_verification()
except MissingAuthKeyError as e :
do something
except MissingRequiredDataError as e:
do something
except APIConnectionError as e:
do something
```
In this case you must have store your API keys in an environment variable.Alternatively you can also do
```python
from pyprembly.data.nigeria import DataVerification
DataVerification(
prembly_app_id='your app id',
prembly_x_api_key='your x api key',
api_version='v2',
environment='live'
).bank_account_verification()
```
We recommend that you store your app id and x api key in an environment variable as PREMBLY_APP_ID and PREMBLY_X_API_KEY respectively.
### Exceptions
There are only three exceptions that you can encounter while making API call.
#### MissingAuthKeyError
`MissingAuthKeyError` tells that pyprembly could not find either your APP_ID or X_API_KEY in your environment variable or in class initialization. Class initialization approach:
#### MissingRequiredDataError
`MissingRequiredDataError` tells that you do not provide a required data for the current method call.
#### APIConnectionError
`APIConnectionError` tells that there is an issue communicating with Prembly API, it can happen due to poor internet connection or system permission
#### InvalidMethodError
`InvalidMethodError` tells that the method used for calling the endpoint is not valid
Raw data
{
"_id": null,
"home_page": "https://github.com/olakayCoder1/pyprembly",
"name": "pyprembly",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.x",
"maintainer_email": "",
"keywords": "api,client,prembly",
"author": "Olanrewaju Kabiru",
"author_email": "programmerolakay@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/9b/48/a1bab62f6bc3d34addf1897cd0cdb34f3ecc69222c5c0dfdb92b67b8aba1/pyprembly-0.0.3.tar.gz",
"platform": null,
"description": "# Prembly Identitypass \r\r\n\r\r\nThe Python library for the Prembly Identitypass API.The Python library provides easy access to Prembly Identitypass API's from Django, Flask, and other Python apps. It abstracts the complexity involved in direct integration and allows you to make quick calls to the APIs.\r\r\n\r\r\n\r\r\n## Table of Contents\r\r\n\r\r\n- [Prembly Identitypass](#prembly-identitypass)\r\r\n - [Table of Contents](#table-of-contents)\r\r\n - [Install](#install)\r\r\n - [Documentation](#documentation)\r\r\n - [Getting Started](#getting-started)\r\r\n - [Configuration](#configuration)\r\r\n - [Country and Available method](#country-and-available-method)\r\r\n - [Nigeria](#nigeria)\r\r\n - [Ghana](#ghana)\r\r\n - [Kenya](#kenya)\r\r\n - [Rwanda](#rwanda)\r\r\n - [Sierra Leone](#sierra-leone)\r\r\n - [South Africa](#south-africa)\r\r\n - [Uganda](#uganda)\r\r\n - [Global](#global)\r\r\n - [FACE VALIDATION](#face-validation)\r\r\n - [RADAR](#radar)\r\r\n - [DOCUMENT](#document)\r\r\n - [Calling Endpoints](#calling-endpoints)\r\r\n - [Exceptions](#exceptions)\r\r\n - [MissingAuthKeyError](#missingauthkeyerror)\r\r\n - [MissingRequiredDataError](#missingrequireddataerror)\r\r\n - [APIConnectionError](#apiconnectionerror)\r\r\n - [InvalidMethodError](#invalidmethoderror)\r\r\n\r\r\n## Install\r\r\n\r\r\n```console\r\r\npip install pyprembly\r\r\n```\r\r\nNote: This is currently under active development\r\r\n\r\r\n## Documentation\r\r\n## Getting Started\r\r\n\r\r\nThe package supports all Prembly Identitypass API endpoints for the following countries:\r\r\n- Nigeria\r\r\n- Kenya\r\r\n- Ghana\r\r\n- Sierra Leone\r\r\n- South Africa\r\r\n- Uganda\r\r\n- Rwanda\r\r\n\r\r\n\r\r\n### Configuration\r\r\n\r\r\nTo use pyprembly you will need to set the following in your environment variable\r\r\n\r\r\n```console\r\r\nPREMBLY_APP_ID=\"your application id\"\r\r\nPREMBLY_X_API_KEY=\"your x_app_key id\"\r\r\nPREMBLY_ENVIRONMENT=\"environment default to test\"\r\r\n```\r\r\n\r\r\nVisit [Prembly](https://prembly.com/) to get both app id and x-api-key\r\r\n\r\r\n### Country and Available method \r\r\nThe available method of the `DataVerification` class are as follow:\r\r\n#### Nigeria \r\r\n\r\r\n\r\r\n```python\r\r\nfrom pyprembly.data.nigeria import DataVerification\r\r\n``` \r\r\n#### Ghana \r\r\n```python\r\r\nfrom pyprembly.data.ghana import DataVerification\r\r\n``` \r\r\n#### Kenya \r\r\n```python\r\r\nfrom pyprembly.data.kenya import DataVerification\r\r\n\r\r\n``` \r\r\n\r\r\n#### Rwanda \r\r\n```python\r\r\nfrom pyprembly.data.rwanda import DataVerification\r\r\n\r\r\n``` \r\r\n\r\r\n#### Sierra Leone \r\r\n```python\r\r\nfrom pyprembly.data.sierra_leone import DataVerification\r\r\n``` \r\r\n\r\r\n#### South Africa \r\r\n```python\r\r\nfrom pyprembly.data.south_africa import DataVerification\r\r\n``` \r\r\n#### Uganda \r\r\n```python\r\r\nfrom pyprembly.data.uganda import DataVerification\r\r\n``` \r\r\n### Global \r\r\n```python\r\r\nfrom pyprembly.business import DataVerification\r\r\n``` \r\r\n\r\r\n### FACE VALIDATION \r\r\n```python\r\r\nfrom pyprembly.face import DataVerification\r\r\n```\r\r\n### RADAR\r\r\n```python\r\r\nfrom pyprembly.radar import DataVerification\r\r\n``` \r\r\n\r\r\n\r\r\n### DOCUMENT\r\r\n```python\r\r\nfrom pyprembly.radar import DataVerification\r\r\n``` \r\r\n\r\r\n### Calling Endpoints\r\r\nTo make a simple API call:\r\r\n\r\r\n```python\r\r\nfrom pypyprembly.data.nigeria import DataVerification\r\r\n\r\r\ntry:\r\r\n DataVerification().bank_account_verification()\r\r\nexcept MissingAuthKeyError as e :\r\r\n do something\r\r\nexcept MissingRequiredDataError as e:\r\r\n do something\r\r\nexcept APIConnectionError as e:\r\r\n do something\r\r\n``` \r\r\nIn this case you must have store your API keys in an environment variable.Alternatively you can also do\r\r\n\r\r\n```python\r\r\nfrom pyprembly.data.nigeria import DataVerification\r\r\n\r\r\nDataVerification(\r\r\n prembly_app_id='your app id',\r\r\n prembly_x_api_key='your x api key',\r\r\n api_version='v2',\r\r\n environment='live'\r\r\n).bank_account_verification()\r\r\n``` \r\r\nWe recommend that you store your app id and x api key in an environment variable as PREMBLY_APP_ID and PREMBLY_X_API_KEY respectively. \r\r\n### Exceptions\r\r\nThere are only three exceptions that you can encounter while making API call. \r\r\n\r\r\n#### MissingAuthKeyError\r\r\n`MissingAuthKeyError` tells that pyprembly could not find either your APP_ID or X_API_KEY in your environment variable or in class initialization. Class initialization approach:\r\r\n\r\r\n#### MissingRequiredDataError\r\r\n`MissingRequiredDataError` tells that you do not provide a required data for the current method call.\r\r\n#### APIConnectionError\r\r\n`APIConnectionError` tells that there is an issue communicating with Prembly API, it can happen due to poor internet connection or system permission\r\r\n\r\r\n#### InvalidMethodError\r\r\n`InvalidMethodError` tells that the method used for calling the endpoint is not valid\r\r\n\r\r\n\r\r\n\r\r\n\r\n\r\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Python bindings for the Prembly IdentityPass API",
"version": "0.0.3",
"split_keywords": [
"api",
"client",
"prembly"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9b48a1bab62f6bc3d34addf1897cd0cdb34f3ecc69222c5c0dfdb92b67b8aba1",
"md5": "3285e2f635bd8e100af6419cf4fa0749",
"sha256": "568218ec3ca4d6cc5c666befb72d924a399a316f6258c15268b811e31713866a"
},
"downloads": -1,
"filename": "pyprembly-0.0.3.tar.gz",
"has_sig": false,
"md5_digest": "3285e2f635bd8e100af6419cf4fa0749",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.x",
"size": 19414,
"upload_time": "2023-04-03T09:22:11",
"upload_time_iso_8601": "2023-04-03T09:22:11.017757Z",
"url": "https://files.pythonhosted.org/packages/9b/48/a1bab62f6bc3d34addf1897cd0cdb34f3ecc69222c5c0dfdb92b67b8aba1/pyprembly-0.0.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-04-03 09:22:11",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "olakayCoder1",
"github_project": "pyprembly",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "pyprembly"
}
JSON
