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
- marshalls Python request objects to HTTP requests
- unmarshalls HTTP responses to Python response objects or Python
exceptions
- handling of all the details concerning authentication
- handling of required meta data
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 example 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.5 or higher is required. In addition, the following package is
required:
- `requests <https://requests.readthedocs.io/>`__ 2.20.0 or higher
This package 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:
::
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:
::
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:
::
pip uninstall onlinepayments-sdk-python3
The required package 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.apiKeyId`` for the API key id to use.
- ``onlinePayments.api.secretApiKey`` for the secret API key to use.
- ``onlinePayments.api.merchantId`` for your merchant ID.
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>`__ packages are
required. These can be installed using the following command:
::
pip install mock mockito
The following commands can then be executed from the ``tests`` directory
to execute the tests:
- Unit tests:
::
python run_unit_tests.py
- Integration tests:
::
python run_integration_tests.py
- Both unit and integration tests:
::
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": null,
"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/9d/12/9c10817d221f6d6a8cf7072e7f0f26a5dca71ac263b334da99645a742437/onlinepayments-sdk-python3-4.21.0.zip",
"platform": "python 3.5",
"description": "Online Payments Python SDK\n==========================\n\nIntroduction\n------------\n\nThe Python SDK helps you to communicate with the payment platform server\nAPI. Its primary features are:\n\n- convenient Python library for the API calls and responses\n\n - marshalls Python request objects to HTTP requests\n - unmarshalls HTTP responses to Python response objects or Python\n exceptions\n\n- handling of all the details concerning authentication\n- handling of required meta data\n\nIts use is demonstrated by an example for each possible call. The\nexamples execute a call using the provided API key.\n\nStructure of this repository\n----------------------------\n\nThis repository consists out of three main components:\n\n#. The source code of the SDK itself: ``/onlinepayments/sdk/``\n#. The source code of the SDK unit tests: ``/tests/unit/``\n#. The source code of the example integration tests:\n ``/tests/integration/``\n\nNote that the source code of the unit tests and integration tests can\nonly be found on GitHub.\n\nRequirements\n------------\n\nPython 3.5 or higher is required. In addition, the following package is\nrequired:\n\n- `requests <https://requests.readthedocs.io/>`__ 2.20.0 or higher\n\nThis package will be installed automatically if the SDK is installed\nmanually or using pip following the below instructions.\n\nInstallation\n------------\n\nTo install the SDK using pip, execute the following command:\n\n::\n\n pip install onlinepayments-sdk-python3\n\nAlternatively, you can install the SDK from a source distribution file:\n\n#. Download the latest version of the Python SDK from GitHub. Choose the\n ``onlinepayments-sdk-python3-x.y.z.zip`` file from the\n `releases <https://github.com/wl-online-payments-direct/sdk-python3/releases>`__\n page, where ``x.y.z`` is the version number.\n#. Execute the following command in the folder where the SDK was\n downloaded to:\n\n ::\n\n pip install onlinepayments-sdk-python3-x.y.z.zip\n\nUninstalling\n------------\n\nAfter the Python SDK has been installed, it can be uninstalled using the\nfollowing command:\n\n::\n\n pip uninstall onlinepayments-sdk-python3\n\nThe required package can be uninstalled in the same way.\n\nRunning tests\n-------------\n\n| There are two types of tests: unit tests and integration tests. The\n unit tests will work out-of-the-box; for the integration tests some\n configuration is required.\n| First, some environment variables need to be set:\n\n- ``onlinePayments.api.apiKeyId`` for the API key id to use.\n- ``onlinePayments.api.secretApiKey`` for the secret API key to use.\n- ``onlinePayments.api.merchantId`` for your merchant ID.\n\nIn order to run the unit and integration tests, the\n`mock <https://pypi.python.org/pypi/mock>`__ backport and\n`mockito <https://pypi.python.org/pypi/mockito>`__ packages are\nrequired. These can be installed using the following command:\n\n::\n\n pip install mock mockito\n\nThe following commands can then be executed from the ``tests`` directory\nto execute the tests:\n\n- Unit tests:\n\n ::\n\n python run_unit_tests.py\n\n- Integration tests:\n\n ::\n\n python run_integration_tests.py\n\n- Both unit and integration tests:\n\n ::\n\n python run_all_tests.py",
"bugtrack_url": null,
"license": "MIT",
"summary": "SDK to communicate with the Online Payments platform using the Online Payments Server API",
"version": "4.21.0",
"project_urls": {
"Homepage": "https://github.com/wl-online-payments-direct/sdk-python3"
},
"split_keywords": [
"online",
"payments",
"sdk"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9d129c10817d221f6d6a8cf7072e7f0f26a5dca71ac263b334da99645a742437",
"md5": "fe92d3bedbfc7156713b388a2a1ba343",
"sha256": "f501db61805f19681327c687f9e0df75cb6ada8acc10c9aa5c6c5ee637f05c76"
},
"downloads": -1,
"filename": "onlinepayments-sdk-python3-4.21.0.zip",
"has_sig": false,
"md5_digest": "fe92d3bedbfc7156713b388a2a1ba343",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 359275,
"upload_time": "2024-04-16T14:53:40",
"upload_time_iso_8601": "2024-04-16T14:53:40.658515Z",
"url": "https://files.pythonhosted.org/packages/9d/12/9c10817d221f6d6a8cf7072e7f0f26a5dca71ac263b334da99645a742437/onlinepayments-sdk-python3-4.21.0.zip",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-16 14:53:40",
"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
