Skip to main content

Python Client for Crimson Hexagon API

Project description

hexpy is a simple python package for working with the Crimson Hexagon API

Why use this client?

  • Easily and securely manage account authentication.

  • Automatically abide by Crimson Hexagon’s rate limits.

  • Automatically convert python data to/from JSON strings.

  • Automatically check requests success.

  • Make it easy to do common tasks like exporting and uploading content.

  • Easily create shell scripts to work with API data.

Requirements

hexpy is compatible with Python 3.5 and higher

Installation

To install the most recent stable release run pip install hexpy.

To install the latest version:

$ git clone https://github.com/sullivancolin/hexpy.git
$ pip install hexpy/

Project Homepage

Visit Github project page for full source code.

Quickstart

>>> from hexpy import HexpyAuthorization, MonitorAPI
>>> auth = HexpyAuthorization(username="user@email.com", password="crimson_login")
>>> monitor_results_client=MonitorAPI(auth)
>>> monitor_results_client.details(monitor_id)
{'categories': [{'hidden': False,
   'id': 6054759055,
   'name': 'Basic Positive',
   'sortOrder': 100,
   'status': 'red',
   'trainingDocs': 0},
  {'hidden': False,
   'id': 6054759059,
   'name': 'Basic Neutral',
   'sortOrder': 101,
   'status': 'red',
   'trainingDocs': 0},
  {'hidden': False,
   'id': 6054759051,
   'name': 'Basic Negative',
   'sortOrder': 102,
   ...

Project details


Download files

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

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

hexpy-0.3.4-py3-none-any.whl (22.1 kB view hashes)

Uploaded Python 3

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