Online Payments Python SDK
==========================
Introduction
------------
The Python SDK helps you to communicate with the payment platform server
API. Its primary features are:
- convenient Python library for the API calls and responses
- marshals Python request objects to HTTP requests
- unmarshals HTTP responses to Python response objects or Python exceptions
- handling of all the details concerning authentication
- handling of required metadata
Its use is demonstrated by an example for each possible call. The examples execute a call using the provided API key.
Structure of this repository
----------------------------
This repository consists out of three main components:
#. The source code of the SDK itself: ``/onlinepayments/sdk/``
#. The source code of the SDK unit tests: ``/tests/unit/``
#. The source code of the SDK integration tests: ``/tests/integration/``
Note that the source code of the unit tests and integration tests can only be found on GitHub.
Requirements
------------
Python 3.7 or higher is required. In addition, the following packages are required:
- `requests <https://requests.readthedocs.io/>`__ 2.25.0 or higher
- `requests-toolbelt <https://toolbelt.readthedocs.io/>`__ 0.8.0 or higher
These packages will be installed automatically if the SDK is installed manually or using pip following the below instructions.
Installation
------------
To install the SDK using pip, execute the following command:
.. code:: bash
pip install onlinepayments-sdk-python3
Alternatively, you can install the SDK from a source distribution file:
#. Download the latest version of the Python SDK from GitHub. Choose the
``onlinepayments-sdk-python3-x.y.z.zip`` file from the
`releases <https://github.com/wl-online-payments-direct/sdk-python3/releases>`__
page, where ``x.y.z`` is the version number.
#. Execute the following command in the folder where the SDK was
downloaded to:
#. Execute the following command in the folder where the SDK was downloaded to:
.. code:: bash
pip install onlinepayments-sdk-python3-x.y.z.zip
Uninstalling
------------
After the Python SDK has been installed, it can be uninstalled using the following command:
.. code:: bash
pip uninstall onlinepayments-sdk-python3
The required packages can be uninstalled in the same way.
Running tests
-------------
There are two types of tests: unit tests and integration tests. The unit tests will work out-of-the-box; for the integration tests some configuration is required.
First, some environment variables need to be set:
- ``onlinePayments.api.v1hmac.apiKeyId`` for the API key id to use.
- ``onlinePayments.api.v1hmac.secretApiKey`` for the secret API key to use.
- ``onlinePayments.api.merchantId`` for your merchant ID.
In addition, to run the proxy integration tests, the proxy URI, username and password should be set in the ``tests/resources/configuration.proxy.ini`` file.
In order to run the unit and integration tests, the `mock <https://pypi.python.org/pypi/mock>`__ backport and `mockito <https://pypi.python.org/pypi/mockito>`__ are required. These can be installed using the following command:
.. code:: bash
pip install mock mockito
The following commands can now be executed from the ``tests`` directory to execute the tests:
- Unit tests:
.. code:: bash
python run_unit_tests.py
- Integration tests:
.. code:: bash
python run_integration_tests.py
- Both unit and integration tests:
.. code:: bash
python run_all_tests.py
Raw data
{
"_id": null,
"home_page": "https://github.com/wl-online-payments-direct/sdk-python3",
"name": "onlinepayments-sdk-python3",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "Online Payments SDK",
"author": "Worldline Direct support team",
"author_email": "82139942+worldline-direct-support-team@users.noreply.github.com",
"download_url": "https://files.pythonhosted.org/packages/41/a4/96d2cd8cf869c949a2c1f6d70e81f0ccfd4c28f80429385bc8a0d3e2a058/onlinepayments_sdk_python3-6.1.0.zip",
"platform": "python 3.7",
"description": "Online Payments Python SDK\r\n==========================\r\n\r\nIntroduction\r\n------------\r\n\r\nThe Python SDK helps you to communicate with the payment platform server\r\nAPI. Its primary features are:\r\n\r\n- convenient Python library for the API calls and responses\r\n\r\n - marshals Python request objects to HTTP requests\r\n - unmarshals HTTP responses to Python response objects or Python exceptions\r\n\r\n- handling of all the details concerning authentication\r\n- handling of required metadata\r\n\r\nIts use is demonstrated by an example for each possible call. The examples execute a call using the provided API key.\r\n\r\nStructure of this repository\r\n----------------------------\r\n\r\nThis repository consists out of three main components:\r\n\r\n#. The source code of the SDK itself: ``/onlinepayments/sdk/``\r\n#. The source code of the SDK unit tests: ``/tests/unit/``\r\n#. The source code of the SDK integration tests: ``/tests/integration/``\r\n\r\nNote that the source code of the unit tests and integration tests can only be found on GitHub.\r\n\r\nRequirements\r\n------------\r\n\r\nPython 3.7 or higher is required. In addition, the following packages are required:\r\n\r\n- `requests <https://requests.readthedocs.io/>`__ 2.25.0 or higher\r\n- `requests-toolbelt <https://toolbelt.readthedocs.io/>`__ 0.8.0 or higher\r\n\r\nThese packages will be installed automatically if the SDK is installed manually or using pip following the below instructions.\r\n\r\nInstallation\r\n------------\r\n\r\nTo install the SDK using pip, execute the following command:\r\n\r\n.. code:: bash\r\n\r\n pip install onlinepayments-sdk-python3\r\n\r\nAlternatively, you can install the SDK from a source distribution file:\r\n\r\n#. Download the latest version of the Python SDK from GitHub. Choose the\r\n ``onlinepayments-sdk-python3-x.y.z.zip`` file from the\r\n `releases <https://github.com/wl-online-payments-direct/sdk-python3/releases>`__\r\n page, where ``x.y.z`` is the version number.\r\n#. Execute the following command in the folder where the SDK was\r\n downloaded to:\r\n\r\n#. Execute the following command in the folder where the SDK was downloaded to:\r\n\r\n .. code:: bash\r\n\r\n pip install onlinepayments-sdk-python3-x.y.z.zip\r\n\r\nUninstalling\r\n------------\r\n\r\nAfter the Python SDK has been installed, it can be uninstalled using the following command:\r\n\r\n.. code:: bash\r\n\r\n pip uninstall onlinepayments-sdk-python3\r\n\r\nThe required packages can be uninstalled in the same way.\r\n\r\nRunning tests\r\n-------------\r\n\r\nThere are two types of tests: unit tests and integration tests. The unit tests will work out-of-the-box; for the integration tests some configuration is required.\r\nFirst, some environment variables need to be set:\r\n- ``onlinePayments.api.v1hmac.apiKeyId`` for the API key id to use.\r\n- ``onlinePayments.api.v1hmac.secretApiKey`` for the secret API key to use.\r\n- ``onlinePayments.api.merchantId`` for your merchant ID.\r\n\r\nIn addition, to run the proxy integration tests, the proxy URI, username and password should be set in the ``tests/resources/configuration.proxy.ini`` file.\r\n\r\nIn order to run the unit and integration tests, the `mock <https://pypi.python.org/pypi/mock>`__ backport and `mockito <https://pypi.python.org/pypi/mockito>`__ are required. These can be installed using the following command:\r\n\r\n.. code:: bash\r\n\r\n pip install mock mockito\r\n\r\nThe following commands can now be executed from the ``tests`` directory to execute the tests:\r\n\r\n- Unit tests:\r\n\r\n .. code:: bash\r\n\r\n python run_unit_tests.py\r\n\r\n- Integration tests:\r\n\r\n .. code:: bash\r\n\r\n python run_integration_tests.py\r\n\r\n- Both unit and integration tests:\r\n\r\n .. code:: bash\r\n\r\n python run_all_tests.py\r\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "SDK to communicate with the Online Payments platform using the Online Payments Server API",
"version": "6.1.0",
"project_urls": {
"Homepage": "https://github.com/wl-online-payments-direct/sdk-python3"
},
"split_keywords": [
"online",
"payments",
"sdk"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "41a496d2cd8cf869c949a2c1f6d70e81f0ccfd4c28f80429385bc8a0d3e2a058",
"md5": "1caeb74397a940adb2316d46aa485198",
"sha256": "06df49b4152b2d053b2bdd1437515ab7e07aa85c2c3b8305d59a4b6b778985af"
},
"downloads": -1,
"filename": "onlinepayments_sdk_python3-6.1.0.zip",
"has_sig": false,
"md5_digest": "1caeb74397a940adb2316d46aa485198",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 450365,
"upload_time": "2025-09-02T08:19:07",
"upload_time_iso_8601": "2025-09-02T08:19:07.444075Z",
"url": "https://files.pythonhosted.org/packages/41/a4/96d2cd8cf869c949a2c1f6d70e81f0ccfd4c28f80429385bc8a0d3e2a058/onlinepayments_sdk_python3-6.1.0.zip",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-09-02 08:19:07",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "wl-online-payments-direct",
"github_project": "sdk-python3",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "onlinepayments-sdk-python3"
}
JSON
