[](https://github.com/wemake-services/wemake-python-styleguide)
# python-tutuka-client
A library for accessing the Tutuka Local API XML-RPC API for python.
[Tutuka Local API Reference](https://developer.tutuka.com/companion-api/api-reference/local-api/)
## Installation
Use the package manager [pipenv](https://pypi.org/project/pipenv/2020.6.2/) to install.
pipenv install python-tutuka-client
## Usage
Use your own Tutuka credentials.
- **terminal_id** - Tutuka issued terminal ID of the terminal requesting the transaction
- **password** - Tutuka issued terminal password
- **host** - Tutuka Host
- **path** - Tutuka Local API path
```python
from tutuka_client import LocalApiClient
client = LocalApiClient(
terminal_id='terminal_id',
password='password',
host='https://companion.uat.tutuka.cloud',
path='/v2_0/XmlRpc.cfm',
)
```
## Class Methods
- [CreateLinkedCard](/docs/create_linked_card.md)
- [LinkCard](/docs/link_card.md)
- [OrderCard](/docs/order_card.md)
- [OrderCardWithPinBlock](/docs/order_card_with_pin_block.md)
- [ActivateCard](/docs/activate_card.md)
- [GetActiveLinkedCards](/docs/get_active_linked_cards.md)
- [ChangePin](/docs/change_pin.md)
- [ResetPin](/docs/reset_pin.md)
- [UpdateBearer](/docs/update_bearer.md)
- [TransferLink](/docs/transfer_link.md)
- [StopCard](/docs/stop_card.md)
- [UnstopCard](/docs/unstop_card.md)
- [Status](/docs/status.md)
- [Set3dSecureCode](/docs/set3d_secure_code.md)
- [UpdateCVV](/docs/update_cvv.md)
- [RetireCard](/docs/retire_card.md)
- [Token Lifecycle Management](/docs/token_lifecycle_management.md)
## Test
Tested with [mamba](https://mamba-framework.readthedocs.io/en/latest/), install pipenv dev packages and then run tests.
pipenv install --dev
pipenv run make test
## Shell
This project has a script to run a shell with a client initialized so you can test run the API.
```shell
TUTUKA_TERMINAL_ID='0000000000' TUTUKA_PASSWORD='' TUTUKA_HOST='http://api.tutuka.com/' TUTUKA_PATH='companion/v2_0/xmlrpc.cfm' bin/shell
```
```python
# Call a pre-defined method (uuid has been imported to help you generate transaction IDs)
client.get_active_linked_cards('00000000-0000-0000-0000-000000000000', str(uuid.uuid4()))
# Call any RPC method
client.execute(
method_name='',
arguments=[]
)
```
## Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
Please make sure to update tests as appropriate.
## License
[MIT](https://choosealicense.com/licenses/mit/)
Raw data
{
"_id": null,
"home_page": "https://github.com/Fondeadora/tutuka-client",
"name": "python-tutuka-client",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "tutuka,client",
"author": "Fondeadora",
"author_email": "tech@fondeadora.com",
"download_url": "https://files.pythonhosted.org/packages/cd/9d/5a1a58b0e657d80b29cb2ee94a9de28b4edd6f718006ba717dce9ed0fa63/python-tutuka-client-1.5.2.tar.gz",
"platform": null,
"description": "[](https://github.com/wemake-services/wemake-python-styleguide)\n\n# python-tutuka-client\n\nA library for accessing the Tutuka Local API XML-RPC API for python.\n\n[Tutuka Local API Reference](https://developer.tutuka.com/companion-api/api-reference/local-api/)\n\n## Installation\n\nUse the package manager [pipenv](https://pypi.org/project/pipenv/2020.6.2/) to install.\n\n pipenv install python-tutuka-client\n\n## Usage\n\nUse your own Tutuka credentials.\n\n- **terminal_id** - Tutuka issued terminal ID of the terminal requesting the transaction\n- **password** - Tutuka issued terminal password\n- **host** - Tutuka Host\n- **path** - Tutuka Local API path\n\n```python\nfrom tutuka_client import LocalApiClient\n\nclient = LocalApiClient(\n terminal_id='terminal_id',\n password='password',\n host='https://companion.uat.tutuka.cloud',\n path='/v2_0/XmlRpc.cfm',\n)\n```\n\n## Class Methods\n\n- [CreateLinkedCard](/docs/create_linked_card.md)\n- [LinkCard](/docs/link_card.md)\n- [OrderCard](/docs/order_card.md)\n- [OrderCardWithPinBlock](/docs/order_card_with_pin_block.md)\n- [ActivateCard](/docs/activate_card.md)\n- [GetActiveLinkedCards](/docs/get_active_linked_cards.md)\n- [ChangePin](/docs/change_pin.md)\n- [ResetPin](/docs/reset_pin.md)\n- [UpdateBearer](/docs/update_bearer.md)\n- [TransferLink](/docs/transfer_link.md)\n- [StopCard](/docs/stop_card.md)\n- [UnstopCard](/docs/unstop_card.md)\n- [Status](/docs/status.md)\n- [Set3dSecureCode](/docs/set3d_secure_code.md)\n- [UpdateCVV](/docs/update_cvv.md)\n- [RetireCard](/docs/retire_card.md)\n- [Token Lifecycle Management](/docs/token_lifecycle_management.md)\n\n## Test\n\nTested with [mamba](https://mamba-framework.readthedocs.io/en/latest/), install pipenv dev packages and then run tests.\n\n pipenv install --dev\n pipenv run make test\n\n## Shell\n\nThis project has a script to run a shell with a client initialized so you can test run the API.\n\n```shell\nTUTUKA_TERMINAL_ID='0000000000' TUTUKA_PASSWORD='' TUTUKA_HOST='http://api.tutuka.com/' TUTUKA_PATH='companion/v2_0/xmlrpc.cfm' bin/shell\n```\n\n```python\n# Call a pre-defined method (uuid has been imported to help you generate transaction IDs)\nclient.get_active_linked_cards('00000000-0000-0000-0000-000000000000', str(uuid.uuid4()))\n\n# Call any RPC method\nclient.execute(\n method_name='',\n arguments=[]\n)\n```\n\n## Contributing\n\nPull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.\n\nPlease make sure to update tests as appropriate.\n\n## License\n\n[MIT](https://choosealicense.com/licenses/mit/)\n",
"bugtrack_url": null,
"license": "",
"summary": "Tutuka XML-RPC Client",
"version": "1.5.2",
"split_keywords": [
"tutuka",
"client"
],
"urls": [
{
"comment_text": "",
"digests": {
"md5": "d2283eb662f9ec9259c0ce0549be45ad",
"sha256": "bbb9a1c89b4ba19dc639a4e69e27082b7aaf51e84a470876bf944d853b01a247"
},
"downloads": -1,
"filename": "python_tutuka_client-1.5.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d2283eb662f9ec9259c0ce0549be45ad",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 9641,
"upload_time": "2022-12-22T19:56:37",
"upload_time_iso_8601": "2022-12-22T19:56:37.211341Z",
"url": "https://files.pythonhosted.org/packages/c3/28/bb455ee694f2c707cf7f0541022755ead181f741a4c112bce6ba6207506f/python_tutuka_client-1.5.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"md5": "8b4ccb4f55f497d3c63c34c412aeab28",
"sha256": "1b9649cea12d65ff797e11e5c3e9044b95f3ebc104c84402d05a7c653d3758e1"
},
"downloads": -1,
"filename": "python-tutuka-client-1.5.2.tar.gz",
"has_sig": false,
"md5_digest": "8b4ccb4f55f497d3c63c34c412aeab28",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 8056,
"upload_time": "2022-12-22T19:56:38",
"upload_time_iso_8601": "2022-12-22T19:56:38.301631Z",
"url": "https://files.pythonhosted.org/packages/cd/9d/5a1a58b0e657d80b29cb2ee94a9de28b4edd6f718006ba717dce9ed0fa63/python-tutuka-client-1.5.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-12-22 19:56:38",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "Fondeadora",
"github_project": "tutuka-client",
"lcname": "python-tutuka-client"
}
JSON
