investec-api-python 0.1.0

Python client for Investec Programmable Banking

About The Project

A simple Python client library to interact with the Investec Bank API, one of a number of existing client implementations which are also mentioned in the acknowledgement section below. This client has a few noteworthy features:

1. No runtime dependencies outside of the Python built-in functionality.
2. A single client interface InvestecOpenApiClient which inherits function definitions for all supported API scopes.
3. Full support for switching to API sandbox endpoints with a single client parameter use_sandbox.
4. Additional HTTP headers can be specified to optimize client performance, such as {'Accept-Encoding': 'gzip, deflate, br'}.
5. Full separation of implementation between API scope implementations for ease of extensions.

(back to top)

Limitations

1. At the time of writing, API support is limited to the account scope and limited card scope. Pull requests are welcome.
2. Although Investec Bank publish their API schema as an Open API specification, I had specific difficulty in generating a client from only the JSON schema files using a few options. More experimentation is needed to obviate the need to write a client from first principles.
3. This library is not yet published to the Python Package Index (PyPi).

(back to top)

Setup

Install Poetry for dependency and runtime management, which already references the submodule in the pyproject.toml configuration. Follow the instructions on the Poetry site here.

(back to top)

Example Usage

For an example of how this library works, check out this simple sample application.

(back to top)

License

Distributed under the MIT License. See LICENSE for more information.

(back to top)

Acknowledgments

Additional well-established Python clients built by the Investec Programmable Banking community:

• ipb-python-wrapper
• investec-open-api-python
• investec-openbanking-python

Investec Open API:

• Investec Open API
• Built with Investec Open API

This project benefits from these supporting projects:

• All the Shields

(back to top)