Skip to main content

Python Client for Crimson Hexagon API

Project description

hexpy

Build Status Coverage PyPI version

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="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,
   ...
}

Project details


Download files

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

Files for hexpy, version 0.7.3
Filename, size File type Python version Upload date Hashes
Filename, size hexpy-0.7.3-py36-none-any.whl (34.8 kB) File type Wheel Python version py36 Upload date Hashes View
Filename, size hexpy-0.7.3.tar.gz (378.6 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page