Skip to main content

Library to interact with the Exonet API.

Project description

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/pypi/l/exonetapi.svg?style=flat-square

Python 3 library for the Exonet API.

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 CHANGELOG 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-0.0.3.tar.gz (9.7 kB view details)

Uploaded Source

File details

Details for the file exonetapi-0.0.3.tar.gz.

File metadata

  • Download URL: exonetapi-0.0.3.tar.gz
  • Upload date:
  • Size: 9.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for exonetapi-0.0.3.tar.gz
Algorithm Hash digest
SHA256 48c1d236860cfea938881c56933532df723b8e9090e6aad67c9f7753827fa483
MD5 e937c91afe5c379391ecffe1c31838a9
BLAKE2b-256 06fae3eaecd989c4f08c22389a88aaecb8ab280c6e47e50f878818c1d61535c4

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page