qosic-sdk
=========
An unofficial python sdk for the `QosIC <https://www.qosic.com/>`__
platform. This platform provides an api to enable mobile money payments
for businesses in Africa.
.. image:: https://img.shields.io/pypi/v/qosic-sdk.svg
:target: https://pypi.python.org/pypi/qosic-sdk
.. image:: https://img.shields.io/pypi/pyversions/qosic-sdk
:target: https://github.com/Tobi-De/qosic-sdk
.. image:: https://readthedocs.org/projects/qosic-sdk/badge/?version=latest
:target: https://qosic-sdk.readthedocs.io/en/latest/?version=latest
:alt: Documentation Status
.. image:: https://img.shields.io/badge/license-MIT-blue.svg
:target: https://github.com/Tobi-De/qosic-sdk/blob/main/LICENSE
.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
:target: https://github.com/psf/black
----
- Free software: MIT license
- Documentation: https://qosic-sdk.readthedocs.io.
Features
--------
- Simple synchronous client to make your payment requests
- Cover 100% of Qosic public api
- Clean and meaningful exceptions
- 100 % test coverage
- Configurable timeouts
Quickstart
----------
For those of you in a hurry, here’s a sample code to get you started.
.. code:: shell
pip install qosic-sdk
.. code:: python3
from dotenv import dotenv_values
from qosic import Client, bj
config = dotenv_values(".env")
moov_client_id = config.get("MOOV_CLIENT_ID")
mtn_client_id = config.get("MTN_CLIENT_ID")
login = config.get("SERVER_LOGIN")
pass = config.get("SERVER_PASSWORD")
def main():
phone = "229XXXXXXXX"
mobile_carriers = [bj.MTN(id=mtn_client_id), bj.MOOV(id=moov_client_id)]
client = Client(login=login, password=pass, mobile_carriers=mobile_carriers)
result = client.pay(phone=phone, amount=500)
print(result)
if result.success:
print(f"Everything went fine")
result = client.refund(reference=result.reference, phone=phone)
print(result)
if __name__ == "__main__":
main()
Credits
-------
This package was created with
`Cookiecutter <https://github.com/audreyr/cookiecutter>`__ and the
`audreyr/cookiecutter-pypackage <https://github.com/audreyr/cookiecutter-pypackage>`__
project template.
Raw data
{
"_id": null,
"home_page": "https://github.com/Tobi-De/qosic-sdk",
"name": "qosic-sdk",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8,<4.0",
"maintainer_email": "",
"keywords": "python,qosic-sdk,qosic,qos,payment,momo,mobile money",
"author": "Tobi-De",
"author_email": "tobidegnon@protonmail.com",
"download_url": "https://files.pythonhosted.org/packages/65/01/2c1eac7915cde3e7cfb9f55f09c7abc8653cbc97ece60511b72af792612b/qosic_sdk-5.0.1.tar.gz",
"platform": null,
"description": "qosic-sdk\n=========\n\nAn unofficial python sdk for the `QosIC <https://www.qosic.com/>`__\nplatform. This platform provides an api to enable mobile money payments\nfor businesses in Africa.\n\n\n.. image:: https://img.shields.io/pypi/v/qosic-sdk.svg\n :target: https://pypi.python.org/pypi/qosic-sdk\n\n.. image:: https://img.shields.io/pypi/pyversions/qosic-sdk\n :target: https://github.com/Tobi-De/qosic-sdk\n\n.. image:: https://readthedocs.org/projects/qosic-sdk/badge/?version=latest\n :target: https://qosic-sdk.readthedocs.io/en/latest/?version=latest\n :alt: Documentation Status\n\n.. image:: https://img.shields.io/badge/license-MIT-blue.svg\n :target: https://github.com/Tobi-De/qosic-sdk/blob/main/LICENSE\n\n.. image:: https://img.shields.io/badge/code%20style-black-000000.svg\n :target: https://github.com/psf/black\n\n----\n\n- Free software: MIT license\n- Documentation: https://qosic-sdk.readthedocs.io.\n\nFeatures\n--------\n\n- Simple synchronous client to make your payment requests\n- Cover 100% of Qosic public api\n- Clean and meaningful exceptions\n- 100 % test coverage\n- Configurable timeouts\n\nQuickstart\n----------\n\nFor those of you in a hurry, here\u2019s a sample code to get you started.\n\n.. code:: shell\n\n pip install qosic-sdk\n\n.. code:: python3\n\n\n from dotenv import dotenv_values\n from qosic import Client, bj\n\n config = dotenv_values(\".env\")\n\n moov_client_id = config.get(\"MOOV_CLIENT_ID\")\n mtn_client_id = config.get(\"MTN_CLIENT_ID\")\n\n login = config.get(\"SERVER_LOGIN\")\n pass = config.get(\"SERVER_PASSWORD\")\n\n def main():\n phone = \"229XXXXXXXX\"\n mobile_carriers = [bj.MTN(id=mtn_client_id), bj.MOOV(id=moov_client_id)]\n client = Client(login=login, password=pass, mobile_carriers=mobile_carriers)\n\n result = client.pay(phone=phone, amount=500)\n print(result)\n if result.success:\n print(f\"Everything went fine\")\n\n result = client.refund(reference=result.reference, phone=phone)\n print(result)\n\n\n if __name__ == \"__main__\":\n main()\n\nCredits\n-------\n\nThis package was created with\n`Cookiecutter <https://github.com/audreyr/cookiecutter>`__ and the\n`audreyr/cookiecutter-pypackage <https://github.com/audreyr/cookiecutter-pypackage>`__\nproject template.\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "An unofficial python sdk for the QosIc platform.",
"version": "5.0.1",
"split_keywords": [
"python",
"qosic-sdk",
"qosic",
"qos",
"payment",
"momo",
"mobile money"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0350f29ecc5b2332c401a7b9fe0a17a87c73e3b4b96a4bdbaf920e771125d624",
"md5": "17c82d689c8e51513ce1e6c2ce5d0f1b",
"sha256": "11d81264298de8a50bc8d5856c8058fd7d2ead99a7f7f35a68dedec5ed972ddc"
},
"downloads": -1,
"filename": "qosic_sdk-5.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "17c82d689c8e51513ce1e6c2ce5d0f1b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8,<4.0",
"size": 10958,
"upload_time": "2023-04-16T09:41:41",
"upload_time_iso_8601": "2023-04-16T09:41:41.854074Z",
"url": "https://files.pythonhosted.org/packages/03/50/f29ecc5b2332c401a7b9fe0a17a87c73e3b4b96a4bdbaf920e771125d624/qosic_sdk-5.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "65012c1eac7915cde3e7cfb9f55f09c7abc8653cbc97ece60511b72af792612b",
"md5": "ad131e804a44e0540d4e0fc8ec6d140c",
"sha256": "ed2006c62983f03c24c0cefe687dbc072e2c36906081207e13481d0ad8ff8400"
},
"downloads": -1,
"filename": "qosic_sdk-5.0.1.tar.gz",
"has_sig": false,
"md5_digest": "ad131e804a44e0540d4e0fc8ec6d140c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8,<4.0",
"size": 8411,
"upload_time": "2023-04-16T09:41:43",
"upload_time_iso_8601": "2023-04-16T09:41:43.783462Z",
"url": "https://files.pythonhosted.org/packages/65/01/2c1eac7915cde3e7cfb9f55f09c7abc8653cbc97ece60511b72af792612b/qosic_sdk-5.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-04-16 09:41:43",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "Tobi-De",
"github_project": "qosic-sdk",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "qosic-sdk"
}
JSON
