circonus

Release v0.0.22. (Installation)

circonus is a Python module for interacting with the Circonus REST API.

from circonus import CirconusClient

CIRCONUS_API_APP_NAME = "my-app"
CIRCONUS_APP_TOKEN = "generated-by-circonus-ui"

circonus = CirconusClient(CIRCONUS_API_APP_NAME, CIRCONUS_APP_TOKEN)

A configured CirconusClient will authenticate via custom Circonus HTTP request headers for all subsequent requests:

response = circonus.get("user/current")
print response.json()

{u'_cid': u'/user/1234',
 u'contact_info': {u'sms': u'', u'xmpp': u''},
 u'email': u'user@example.com',
 u'firstname': u'Ewe',
 u'lastname': u'Sure'}

Features

circonus is built on the excellent requests library. It extends or improves the standard Circonus REST API by providing several conveniences and features:

• Application name and token handling
• Resource tagging
• An annotation decorator and context manager
• Error logging
• Opinionated collectd system metric graphing

User Guide

• Installation
• Core
  • Get
  • Create
  • Update
  • Delete
• Annotation
  • Explicit
  • Decorator
  • Context Manager
• Tag

API Documentation

• API
  • Client Interface
  • Classes
  • Modules

Changelog

• Changelog
  • Release History