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

Uploaded Source

File details

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

File metadata

  • Download URL: exonetapi-0.0.4.tar.gz
  • Upload date:
  • Size: 9.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.11.0 pkginfo/1.4.2 requests/2.18.4 setuptools/28.8.0 requests-toolbelt/0.8.0 tqdm/4.23.4 CPython/3.6.4

File hashes

Hashes for exonetapi-0.0.4.tar.gz
Algorithm Hash digest
SHA256 18763f9e6770a35bf0f5d6c298ec605146b4511f9ebb7cd8ceacac751f176b35
MD5 52077dabf8885ba8eae17aa0c22ecc88
BLAKE2b-256 6d14aeb3b707eff3c82947b667126cb1f79982ca3743c9b5274c046f19736399

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