Worldline Connect Python SDK
Introduction
The Python SDK helps you to communicate with the Worldline Connect 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 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 2.25.0 or higher
requests-toolbelt 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:
pip install connect-sdk-python3Alternatively, 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.tar.gz file from the 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 connect_sdk_python3-x.y.z.tar.gz
Uninstalling
After the Python SDK has been installed, it can be uninstalled using the following command:
pip uninstall connect-sdk-python3The 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 backport and mockito are required. These can be installed using the following command:
pip install mock mockitoThe following commands can now be executed from the tests directory to execute the tests:
Unit tests:
python run_unit_tests.pyIntegration tests:
python run_integration_tests.pyBoth unit and integration tests:
python run_all_tests.py
2 maintainers
Metadata
2 maintainers
Release files for connect-sdk-python3 6.3.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| connect_sdk_python3-6.3.0.tar.gz | 254.9 kB | Without provenance | Details |
Release files / connect_sdk_python3-6.3.0.tar.gz
| Download URL | connect_sdk_python3-6.3.0.tar.gz |
|---|---|
| Size | 254.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
8663f284382aad3c5f1ed17ea90b680c840e2b135c99588ee33ab8de5a1571d8
|
|
BLAKE2b-256 checksum How to use checksums |
cb3d311c06c2023523751a1da75f2b958251fbf2222971dec6a1fd21e9dd711c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.11.15
|
Security for connect-sdk-python3 6.3.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
