README.md

A Python Client for the Crimson Hexagon API

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

---

Project Homepage

Documentation: hexpy

Source Code: Github

---

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/

Quick Start

>>> from hexpy import HexpySession, MonitorAPI
>>> session = HexpySession.login(username="[email protected]", 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,
   ...
}