Skip to main content

Python Client for Crimson Hexagon API

Project description

A Python Client for the Crimson Hexagon API

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.6 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.

Quick Start

>>> from hexpy import HexpySession, MonitorAPI
>>> session = HexpySession.login(username="user@email.com", password="crimson_login")
>>> monitor_results_client = MonitorAPI(session)
>>> 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,
   ...

>>> session.close()

Project details


Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
hexpy-0.5.3-py36-none-any.whl (26.9 kB) Copy SHA256 hash SHA256 Wheel py36 Aug 13, 2018
hexpy-0.5.3.tar.gz (250.8 kB) Copy SHA256 hash SHA256 Source None Aug 13, 2018

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page