# rattifyapi-python
Python plugin for [RattifApi](https://rattify.com/) View on [pypi.python.org](https://pypi.org/project/rattifyapi/)
## Installation
```sh
pip install rattifyapi
```
## Example
```python
from rattifyapi.rattify import Rattify
secret_key = "rt_test_4973"
rattify = Rattify(secret_key=secret_key)
# to use transaction class
print(rattify.user.list())
# initiate a generic
data = {
"first_name": "John",
"last_name": "Doe",
"email": "john.doe@email.com",
"date_of_birth": "2000-12-24",
"country": "Ghana",
}
print(rattify.generic.initialize(data))
# get user
print(rattify.user.verify(reference="e1b6679c5aad4bd3999953ac78e677a79d28d539085e409ebde1be640ebc27e7"))
```
## Static Use
To start using the Rattify Python API, you need to start by setting your secret key.
You can set your secret key in your environment by running:
```sh
export SECRET_KEY = 'your_secret_secret_key'
```
After exporting the keys, you can use the api like this
```python
from rattifyapi.generic import Generic
from rattifyapi.users import User
# list users
print(User.list())
# initiate a generic
data = {
"first_name": "John",
"last_name": "Doe",
"email": "john.doe@email.com",
"date_of_birth": "2000-12-24",
"country": "Ghana",
}
print(Generic.initialize(data))
# get user
print(User.verify(reference="reference"))
```
Raw data
{
"_id": null,
"home_page": "https://github.com/ktechhub/rattifyapi",
"name": "rattifyapi",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8.0",
"maintainer_email": "",
"keywords": "rattify rattifyapi python library",
"author": "KtechHub",
"author_email": "info@ktechhub.com",
"download_url": "",
"platform": null,
"description": "\n# rattifyapi-python\nPython plugin for [RattifApi](https://rattify.com/) View on [pypi.python.org](https://pypi.org/project/rattifyapi/)\n\n## Installation\n```sh\npip install rattifyapi\n```\n## Example\n\n```python\nfrom rattifyapi.rattify import Rattify\n\nsecret_key = \"rt_test_4973\"\n\nrattify = Rattify(secret_key=secret_key)\n\n# to use transaction class\nprint(rattify.user.list())\n\n# initiate a generic\ndata = {\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"email\": \"john.doe@email.com\",\n \"date_of_birth\": \"2000-12-24\",\n \"country\": \"Ghana\",\n}\nprint(rattify.generic.initialize(data))\n\n# get user\nprint(rattify.user.verify(reference=\"e1b6679c5aad4bd3999953ac78e677a79d28d539085e409ebde1be640ebc27e7\"))\n```\n\n## Static Use\nTo start using the Rattify Python API, you need to start by setting your secret key.\n\nYou can set your secret key in your environment by running:\n\n```sh\nexport SECRET_KEY = 'your_secret_secret_key'\n```\n\nAfter exporting the keys, you can use the api like this\n```python\nfrom rattifyapi.generic import Generic\nfrom rattifyapi.users import User\n\n# list users\nprint(User.list())\n\n# initiate a generic\ndata = {\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"email\": \"john.doe@email.com\",\n \"date_of_birth\": \"2000-12-24\",\n \"country\": \"Ghana\",\n}\nprint(Generic.initialize(data))\n\n# get user\nprint(User.verify(reference=\"reference\"))\n```\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A python library to consume Rattify API",
"version": "0.2.2",
"project_urls": {
"Homepage": "https://github.com/ktechhub/rattifyapi"
},
"split_keywords": [
"rattify",
"rattifyapi",
"python",
"library"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e04e35361b9f31fed0d94c6662d1af1d1307bc6732220bcf3619033fbd195153",
"md5": "08b45cb70486f19552ef2a15f3626690",
"sha256": "5ff87dd00455fab327612e9e88d960161582083561add07639349b1821e37aa4"
},
"downloads": -1,
"filename": "rattifyapi-0.2.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "08b45cb70486f19552ef2a15f3626690",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8.0",
"size": 5049,
"upload_time": "2023-09-05T17:37:36",
"upload_time_iso_8601": "2023-09-05T17:37:36.550140Z",
"url": "https://files.pythonhosted.org/packages/e0/4e/35361b9f31fed0d94c6662d1af1d1307bc6732220bcf3619033fbd195153/rattifyapi-0.2.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-09-05 17:37:36",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ktechhub",
"github_project": "rattifyapi",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "rattifyapi"
}
JSON
