Skip to main content

Library to interact with the Exonet API.

Project description

Python 3 library for the Exonet API.

https://img.shields.io/pypi/v/exonetapi.svg?style=flat-square https://img.shields.io/pypi/pyversions/exonetapi.svg?style=flat-square https://img.shields.io/lgtm/grade/python/g/exonet/exonet-api-python.svg https://img.shields.io/pypi/l/exonetapi.svg?style=flat-square

Conventions

  • Code style guide: PEP 8.

  • Docstring conventions: PEP 257 and reStructuredText.

Install

Install using pip:

pip install exonetapi

Usage

Example to get the user details of the authorised user:

from exonetapi import Client

# Create a new Client.
client = Client('https://api.exonet.nl')

# Authorize with a personal access token.
client.authenticator.set_token('<YOUR_TOKEN>')

# Make an API call. Get details of the authorized user.
user_details = client.resource('me').get()

# Print user's name.
print('Autorized as: {name}'.format(
    name=user_details.attribute('name')
))

See the /docs directory for complete documentation and additional code snippets.

Examples

The /examples directory contains ready to use scripts to help you get started. These examples can be executed with your personal access token. One of them gets a ticket with it’s emails and prints the details:

$ python examples/ticket_details.py <YOUR-TOKEN>

This should make two API calls and print the ticket and email details for one of your tickets.

Testing

Run unit tests and coverage:

coverage run -m unittest discover tests -v && coverage html

Change log

Please see releases <https://github.com/exonet/exonet-api-python/releases> for more information on what has changed recently.

Security

If you discover any security related issues please email support@exonet.nl instead of using the issue tracker.

Credits

License

The MIT License (MIT). Please see [License File](LICENSE.md) for more information.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

exonetapi-3.0.3.tar.gz (14.2 kB view hashes)

Uploaded source

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page