Skip to main content

Python Client Library for PagerDuty's REST API

Project description

https://travis-ci.org/dropbox/pygerduty.svg?branch=master

Pygerduty

Python Library for PagerDuty’s v1 REST API.

This library is currently evolving and backwards compatibility cannot always be guaranteed at this time.

Installation

You can install with pip install pygerduty.

If you want to install from source, then python setup.py install.

Requirements

Pygerduty is tested against >= Python 2.5

simplejson is required on Python2.5

Documentation

Pygerduty is a thin wrapper around PagerDuty’s APIs. You will need to refer to the the PagerDuty Documentation for all available parameters to pass and all available attributes on responses.

The main methods available to resources are list, show, create, update, and delete. Not all resources have endpoints for all of the above methods. Again, refer to the PagerDuty Documentation to see all available endpoints.

Top level resources will be accessible via the PagerDuty object and nested resources available on containers returned from their parent resource.

Examples

Instantiating a client:

import pygerduty
pager = pygerduty.PagerDuty("foobar", "SOMEAPIKEY123456")

Listing a resource:

for schedule in pager.schedules.list():
    print schedule.id, schedule.name

# PX7F8S3 Primary
# PJ48C0S Tertiary
# PCJ94SK Secondary

Getting a resource by ID:

schedule = pager.schedules.show("PX7F8S3")

Creating a resource:

user = next(pager.users.list(query="gary", limit=1))
override = schedule.overrides.create(
    start="2012-12-16", end="2012-12-17", user_id=user.id)

Delete a resource:

schedule.overrides.delete(override.id)

Updating a resource:

pagerduty.users.update(user.id, name="Gary Example")

Acknowledging a group by incidents:

me = next(pager.users.list(query="me@you.com", limit=1))
for incident in pagerduty.incidents.list(status='triggered'):
    incident.acknowledge(requester_id=me.id)

Project details


Download files

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

Source Distribution

pygerduty-py3-0.28.2.tar.gz (8.8 kB view details)

Uploaded Source

File details

Details for the file pygerduty-py3-0.28.2.tar.gz.

File metadata

File hashes

Hashes for pygerduty-py3-0.28.2.tar.gz
Algorithm Hash digest
SHA256 bbe9b67cad5e27ca9932bde745250bfa378740212f7a7a333a71063c2e342406
MD5 c6e823440950618a4f4007d6ac8f3a28
BLAKE2b-256 47fb30299cc95799558084c9415681d5b0ea16d6bb5d48a7588fd6411e0189a6

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page