Omise Python Client
Please raise an issue or contact email@example.com if you have any question regarding this library and the functionality it provides.
If you simply want to use Omise Python client in your application, you can install it using pip:
pip install omise
easy_install in case your system do not have pip installed:
The Omise Python client officially supports the following Python versions:
- Python 2.7
- Python 3.5
- Python 3.6
- Python 3.7
- Python 3.8
Any versions not listed here may work but they are not automatically tested.
Please refer to an example in API documentation or the help function for documentation. For basic usage, you can use the module in your application by importing the
omise module and set the secret key and public key:
>>> import omise >>> omise.api_secret = 'skey_test_4xsjvwfnvb2g0l81sjz' >>> omise.api_public = 'pkey_test_4xs8breq32civvobx15'
After both keys are set, you can now use all the APIs. For example, to create a new customer without any cards associated to the customer:
>>> customer = omise.Customer.create( >>> description='John Doe', >>> firstname.lastname@example.org' >>> ) <Customer id='cust_test_4xtrb759599jsxlhkrb' at 0x7ffab7136910>
Then to retrieve, update and destroy that customer:
>>> customer = omise.Customer.retrieve('cust_test_4xtrb759599jsxlhkrb') >>> customer.description = 'John W. Doe' >>> customer.update() <Customer id='cust_test_4xtrb759599jsxlhkrb' at 0x7ffab7136910> >>> customer.destroy() >>> customer.destroyed True
In case of any errors (such as authentication failure, invalid card and others as listed in errors section in the documentation), the error of a subclass
omise.errors.BaseError will be raise. The application code must be handling these errors as appropriate.
In case you want to enforce API version the application use, you can specify it by setting
api_version. The version specified by this settings will override the version setting in your account. This is useful if you have multiple environments with different API versions (e.g. development on the latest but production on the older version).
>>> import omise >>> omise.api_version = '2014-07-27'
It is highly recommended to set this version to the current version you're using.
The Omise Python client uses
tox and Docker for testing.
All changes must be tested against all supported Python versions.
You can run tests using the following instructions:
- Install Docker
docker run -it -v $(pwd):/app --rm $(docker build -q .)
This command builds a Docker image using the Dockerfile, mounts the current directory to the container's
/app directory, and runs the default entrypoint for the image:
After you've made your changes and run the tests, please open a Pull Request.