Worldline Connect Python SDK
============================
Introduction
------------
The Python SDK helps you to communicate with the `Worldline Connect <https://docs.connect.worldline-solutions.com/>`__ 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 metadata
Its use is demonstrated by an example for each possible call. The examples execute a call using the provided API keys.
See the `Worldline Connect Developer Hub <https://docs.connect.worldline-solutions.com/documentation/sdk/server/python/>`__ for more information on how to use the SDK.
Structure of this repository
----------------------------
This repository consists out of four main components:
#. The source code of the SDK itself: ``/worldline/connect/sdk/``
#. The source code of the SDK unit tests: ``/tests/unit/``
#. The source code of the SDK integration tests: ``/tests/integration/``
#. Usage examples: ``/examples/``
Note that the source code of the unit tests and integration tests and the examples 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 connect-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 ``connect-sdk-python3-x.y.z.zip`` file from the `releases <https://github.com/Worldline-Global-Collect/connect-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:
.. code:: bash
pip install connect-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 connect-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:
- ``connect.api.apiKeyId`` for the API key id to use. This can be retrieved from the Configuration Center.
- ``connect.api.secretApiKey`` for the secret API key to use. This can be retrieved from the Configuration Center.
- ``connect.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/Worldline-Global-Collect/connect-sdk-python3",
"name": "connect-sdk-python3",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "Worldline Global Collect Connect SDK",
"author": "Worldline Global Collect",
"author_email": "github.connect@worldline.com",
"download_url": "https://files.pythonhosted.org/packages/eb/6d/c0986c7ed34d9d1a076a4e5fff0a0d867868681c85af5cea3e57d1ca2098/connect-sdk-python3-4.0.1.zip",
"platform": "python 3.7",
"description": "Worldline Connect Python SDK\n============================\n\nIntroduction\n------------\n\nThe Python SDK helps you to communicate with the `Worldline Connect <https://docs.connect.worldline-solutions.com/>`__ Server API. 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 exceptions\n\n- handling of all the details concerning authentication\n- handling of required metadata\n\nIts use is demonstrated by an example for each possible call. The examples execute a call using the provided API keys.\n\nSee the `Worldline Connect Developer Hub <https://docs.connect.worldline-solutions.com/documentation/sdk/server/python/>`__ for more information on how to use the SDK.\n\nStructure of this repository\n----------------------------\n\nThis repository consists out of four main components:\n\n#. The source code of the SDK itself: ``/worldline/connect/sdk/``\n#. The source code of the SDK unit tests: ``/tests/unit/``\n#. The source code of the SDK integration tests: ``/tests/integration/``\n#. Usage examples: ``/examples/``\n\nNote that the source code of the unit tests and integration tests and the examples can only be found on GitHub.\n\nRequirements\n------------\n\nPython 3.7 or higher is required. In addition, the following packages are required:\n\n- `requests <https://requests.readthedocs.io/>`__ 2.25.0 or higher\n- `requests-toolbelt <https://toolbelt.readthedocs.io/>`__ 0.8.0 or higher\n\nThese packages will be installed automatically if the SDK is installed manually or using pip following the below instructions.\n\nInstallation\n------------\n\nTo install the SDK using pip, execute the following command:\n\n.. code:: bash\n\n pip install connect-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 ``connect-sdk-python3-x.y.z.zip`` file from the `releases <https://github.com/Worldline-Global-Collect/connect-sdk-python3/releases>`__ page, where ``x.y.z`` is the version number.\n\n#. Execute the following command in the folder where the SDK was downloaded to:\n\n .. code:: bash\n\n pip install connect-sdk-python3-x.y.z.zip\n\nUninstalling\n------------\n\nAfter the Python SDK has been installed, it can be uninstalled using the following command:\n\n.. code:: bash\n\n pip uninstall connect-sdk-python3\n\nThe required packages can be uninstalled in the same way.\n\nRunning tests\n-------------\n\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.\nFirst, some environment variables need to be set:\n\n- ``connect.api.apiKeyId`` for the API key id to use. This can be retrieved from the Configuration Center.\n- ``connect.api.secretApiKey`` for the secret API key to use. This can be retrieved from the Configuration Center.\n- ``connect.api.merchantId`` for your merchant ID.\n\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.\n\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:\n\n.. code:: bash\n\n pip install mock mockito\n\nThe following commands can now be executed from the ``tests`` directory to execute the tests:\n\n- Unit tests:\n\n .. code:: bash\n\n python run_unit_tests.py\n\n- Integration tests:\n\n .. code:: bash\n\n python run_integration_tests.py\n\n- Both unit and integration tests:\n\n .. code:: bash\n\n python run_all_tests.py\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "SDK to communicate with the Worldline Global Collect platform using the Worldline Connect Server API",
"version": "4.0.1",
"project_urls": {
"Homepage": "https://github.com/Worldline-Global-Collect/connect-sdk-python3"
},
"split_keywords": [
"worldline",
"global",
"collect",
"connect",
"sdk"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "eb6dc0986c7ed34d9d1a076a4e5fff0a0d867868681c85af5cea3e57d1ca2098",
"md5": "228b6f524f9bce6ac3125c18843f44ab",
"sha256": "dd263b7dd45b9e94eba0ca72f45015028abcf71714592c4199303e5305d942d0"
},
"downloads": -1,
"filename": "connect-sdk-python3-4.0.1.zip",
"has_sig": false,
"md5_digest": "228b6f524f9bce6ac3125c18843f44ab",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 544062,
"upload_time": "2024-04-18T13:36:05",
"upload_time_iso_8601": "2024-04-18T13:36:05.146523Z",
"url": "https://files.pythonhosted.org/packages/eb/6d/c0986c7ed34d9d1a076a4e5fff0a0d867868681c85af5cea3e57d1ca2098/connect-sdk-python3-4.0.1.zip",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-18 13:36:05",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Worldline-Global-Collect",
"github_project": "connect-sdk-python3",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "connect-sdk-python3"
}
JSON
