Metadata-Version: 1.1
Name: onlinepayments-sdk-python2
Version: 4.5.0
Summary: SDK to communicate with the Online Payments platform using the Online Payments Server API
Home-page: https://github.com/wl-online-payments-direct/sdk-python2
Author: Worldline Direct support team
Author-email: 82139942+worldline-direct-support-team@users.noreply.github.com
License: MIT
Description: 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 2.7 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-python2
        
        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-python2-x.y.z.zip`` file from the
           `releases <https://github.com/wl-online-payments-direct/sdk-python2/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-python2-x.y.z.zip
        
        Uninstalling
        ------------
        
        After the Python SDK has been installed, it can be uninstalled using the
        following command:
        
        ::
        
            pip uninstall onlinepayments-sdk-python2
        
        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
        
        Note: in the current version of the unit tests, two errors will pop up
        ([Errno 10053] for Windows and [Errno 32] for Linux), indicating that
        there was a client disconnect. These errors occur during cleanup of the
        tests and do not hinder the tests in any way, and should therefore be
        ignored.
        
Keywords: Online Payments SDK
Platform: python 2.7
Classifier: Development Status :: 5 - Production/Stable
Classifier: Operating System :: POSIX :: Linux
Classifier: Operating System :: Microsoft :: Windows
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 2 :: Only
Classifier: Programming Language :: Python :: 2.7
Classifier: Topic :: Office/Business :: Financial
Classifier: License :: OSI Approved :: MIT License
