-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Generated API docs for version 0.1.0
- Loading branch information
1 parent
cfa28a0
commit 2f73174
Showing
134 changed files
with
36,148 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,191 @@ | ||
| <!DOCTYPE html> | ||
|
|
||
| <html lang="en" data-content_root="./"> | ||
| <head> | ||
| <meta charset="utf-8" /> | ||
| <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" /> | ||
|
|
||
| <title>Worldline Acquiring Python SDK — acquiring-sdk-python 0.1.0 documentation</title> | ||
| <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" /> | ||
| <link rel="stylesheet" type="text/css" href="_static/basic.css?v=c058f7c8" /> | ||
| <link rel="stylesheet" type="text/css" href="_static/alabaster.css?v=27fed22d" /> | ||
| <script src="_static/documentation_options.js?v=01f34227"></script> | ||
| <script src="_static/doctools.js?v=9a2dae69"></script> | ||
| <script src="_static/sphinx_highlight.js?v=dc90522c"></script> | ||
| <link rel="index" title="Index" href="genindex.html" /> | ||
| <link rel="search" title="Search" href="search.html" /> | ||
|
|
||
| <link rel="stylesheet" href="_static/custom.css" type="text/css" /> | ||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
| </head><body> | ||
|
|
||
|
|
||
| <div class="document"> | ||
| <div class="documentwrapper"> | ||
| <div class="bodywrapper"> | ||
|
|
||
|
|
||
| <div class="body" role="main"> | ||
|
|
||
| <section id="worldline-acquiring-python-sdk"> | ||
| <h1>Worldline Acquiring Python SDK<a class="headerlink" href="#worldline-acquiring-python-sdk" title="Link to this heading">¶</a></h1> | ||
| <section id="introduction"> | ||
| <h2>Introduction<a class="headerlink" href="#introduction" title="Link to this heading">¶</a></h2> | ||
| <p>The Python SDK helps you to communicate with the Worldline Acquiring API. Its primary features are:</p> | ||
| <ul class="simple"> | ||
| <li><p>convenient Python library for the API calls and responses</p> | ||
| <ul> | ||
| <li><p>marshals Python request objects to HTTP requests</p></li> | ||
| <li><p>unmarshals HTTP responses to Python response objects or Python exceptions</p></li> | ||
| </ul> | ||
| </li> | ||
| <li><p>handling of all the details concerning authentication</p></li> | ||
| <li><p>handling of required metadata</p></li> | ||
| </ul> | ||
| <p>See the <a class="reference external" href="https://docs.acquiring.worldline-solutions.com/Developer-Tools/sdk/python">Worldline Acquiring Documentation</a> for more information on how to use the SDK.</p> | ||
| </section> | ||
| <section id="structure-of-this-repository"> | ||
| <h2>Structure of this repository<a class="headerlink" href="#structure-of-this-repository" title="Link to this heading">¶</a></h2> | ||
| <p>This repository consists out of four main components:</p> | ||
| <ol class="arabic simple"> | ||
| <li><p>The source code of the SDK itself: <code class="docutils literal notranslate"><span class="pre">/worldline/acquiring/sdk/</span></code></p></li> | ||
| <li><p>The source code of the SDK unit tests: <code class="docutils literal notranslate"><span class="pre">/tests/unit/</span></code></p></li> | ||
| <li><p>The source code of the SDK integration tests: <code class="docutils literal notranslate"><span class="pre">/tests/integration/</span></code></p></li> | ||
| </ol> | ||
| <p>Note that the source code of the unit tests and integration tests can only be found on GitHub.</p> | ||
| </section> | ||
| <section id="requirements"> | ||
| <h2>Requirements<a class="headerlink" href="#requirements" title="Link to this heading">¶</a></h2> | ||
| <p>Python 3.7 or higher is required. In addition, the following packages are required:</p> | ||
| <ul class="simple"> | ||
| <li><p><a class="reference external" href="https://requests.readthedocs.io/">requests</a> 2.25.0 or higher</p></li> | ||
| <li><p><a class="reference external" href="https://toolbelt.readthedocs.io/">requests-toolbelt</a> 0.8.0 or higher</p></li> | ||
| </ul> | ||
| <p>These packages will be installed automatically if the SDK is installed manually or using pip following the below instructions.</p> | ||
| </section> | ||
| <section id="installation"> | ||
| <h2>Installation<a class="headerlink" href="#installation" title="Link to this heading">¶</a></h2> | ||
| <p>To install the SDK using pip, execute the following command:</p> | ||
| <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>pip<span class="w"> </span>install<span class="w"> </span>acquiring-sdk-python | ||
| </pre></div> | ||
| </div> | ||
| <p>Alternatively, you can install the SDK from a source distribution file:</p> | ||
| <ol class="arabic"> | ||
| <li><p>Download the latest version of the Python SDK from GitHub. Choose the <code class="docutils literal notranslate"><span class="pre">acquiring-sdk-python-x.y.z.zip</span></code> file from the <a class="reference external" href="https://github.com/Worldline-Acquiring/acquiring-sdk-python/releases">releases</a> page, where <code class="docutils literal notranslate"><span class="pre">x.y.z</span></code> is the version number.</p></li> | ||
| <li><p>Execute the following command in the folder where the SDK was downloaded to:</p> | ||
| <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>pip<span class="w"> </span>install<span class="w"> </span>acquiring-sdk-python-x.y.z.zip | ||
| </pre></div> | ||
| </div> | ||
| </li> | ||
| </ol> | ||
| </section> | ||
| <section id="uninstalling"> | ||
| <h2>Uninstalling<a class="headerlink" href="#uninstalling" title="Link to this heading">¶</a></h2> | ||
| <p>After the Python SDK has been installed, it can be uninstalled using the following command:</p> | ||
| <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>pip<span class="w"> </span>uninstall<span class="w"> </span>acquiring-sdk-python | ||
| </pre></div> | ||
| </div> | ||
| <p>The required packages can be uninstalled in the same way.</p> | ||
| </section> | ||
| <section id="running-tests"> | ||
| <h2>Running tests<a class="headerlink" href="#running-tests" title="Link to this heading">¶</a></h2> | ||
| <p>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:</p> | ||
| <ul class="simple"> | ||
| <li><p><code class="docutils literal notranslate"><span class="pre">acquiring.api.oauth2.clientId</span></code> for the OAUth2 client id to use.</p></li> | ||
| <li><p><code class="docutils literal notranslate"><span class="pre">acquiring.api.oauth2.clientSecret</span></code> for the OAuth2 client secret to use.</p></li> | ||
| <li><p><code class="docutils literal notranslate"><span class="pre">acquiring.api.merchantId</span></code> for your merchant ID.</p></li> | ||
| </ul> | ||
| <p>In addition, to run the proxy integration tests, the proxy URI, username and password should be set in the <code class="docutils literal notranslate"><span class="pre">tests/resources/configuration.proxy.ini</span></code> file.</p> | ||
| <p>In order to run the unit and integration tests, the <a class="reference external" href="https://pypi.python.org/pypi/mock">mock</a> backport and <a class="reference external" href="https://pypi.python.org/pypi/mockito">mockito</a> are required. These can be installed using the following command:</p> | ||
| <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>pip<span class="w"> </span>install<span class="w"> </span>mock<span class="w"> </span>mockito | ||
| </pre></div> | ||
| </div> | ||
| <p>The following commands can now be executed from the <code class="docutils literal notranslate"><span class="pre">tests</span></code> directory to execute the tests:</p> | ||
| <ul> | ||
| <li><p>Unit tests:</p> | ||
| <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>python<span class="w"> </span>run_unit_tests.py | ||
| </pre></div> | ||
| </div> | ||
| </li> | ||
| <li><p>Integration tests:</p> | ||
| <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>python<span class="w"> </span>run_integration_tests.py | ||
| </pre></div> | ||
| </div> | ||
| </li> | ||
| <li><p>Both unit and integration tests:</p> | ||
| <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>python<span class="w"> </span>run_all_tests.py | ||
| </pre></div> | ||
| </div> | ||
| </li> | ||
| </ul> | ||
| </section> | ||
| </section> | ||
|
|
||
|
|
||
| </div> | ||
|
|
||
| </div> | ||
| </div> | ||
| <div class="sphinxsidebar" role="navigation" aria-label="Main"> | ||
| <div class="sphinxsidebarwrapper"> | ||
| <h1 class="logo"><a href="index.html">acquiring-sdk-python</a></h1> | ||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
| <search id="searchbox" style="display: none" role="search"> | ||
| <div class="searchformwrapper"> | ||
| <form class="search" action="search.html" method="get"> | ||
| <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false" placeholder="Search"/> | ||
| <input type="submit" value="Go" /> | ||
| </form> | ||
| </div> | ||
| </search> | ||
| <script>document.getElementById('searchbox').style.display = "block"</script><h3>Navigation</h3> | ||
|
|
||
| <div class="relations"> | ||
| <h3>Related Topics</h3> | ||
| <ul> | ||
| <li><a href="index.html">Documentation overview</a><ul> | ||
| </ul></li> | ||
| </ul> | ||
| </div> | ||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
| </div> | ||
| </div> | ||
| <div class="clearer"></div> | ||
| </div> | ||
| <div class="footer"> | ||
| ©Copyright (c) 2024 Worldline Financial Services (Europe) SA. | ||
|
|
||
| | | ||
| Powered by <a href="https://www.sphinx-doc.org/">Sphinx 8.0.2</a> | ||
| & <a href="https://alabaster.readthedocs.io">Alabaster 1.0.0</a> | ||
|
|
||
| | | ||
| <a href="_sources/README.rst.txt" | ||
| rel="nofollow">Page source</a> | ||
| </div> | ||
|
|
||
|
|
||
|
|
||
|
|
||
| </body> | ||
| </html> |
Oops, something went wrong.