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-2.1.0.tar.gz (12.0 kB view details)

Uploaded Source

File details

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

File metadata

  • Download URL: exonetapi-2.1.0.tar.gz
  • Upload date:
  • Size: 12.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.15.0 pkginfo/1.5.0.1 requests/2.11.1 setuptools/38.2.4 requests-toolbelt/0.9.1 tqdm/4.39.0 CPython/2.7.10

File hashes

Hashes for exonetapi-2.1.0.tar.gz
Algorithm Hash digest
SHA256 6c9f7d0cd6ee755aced20597f50e0cfdef37f6fcfac5e0e80e99081bcd1d498f
MD5 4cb1698adc953702b3adc73a836df475
BLAKE2b-256 04afa223530461971d3239158038e8714c790a5cb493ccbbefc71fdf1fc398a8

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