Skip to main content

Python Client Library for PagerDuty's REST API

Project description

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 = pager.users.list(query="gary")[0]
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")

Project details


Release history Release notifications

History Node

0.37.0

History Node

0.36.3

History Node

0.36.2

History Node

0.36.1

History Node

0.36.0

History Node

0.35.2

History Node

0.35.1

History Node

0.35.0

History Node

0.34.0

History Node

0.33.0

History Node

0.32.1

History Node

0.32.0

History Node

0.31.0

History Node

0.30.1

History Node

0.30.0

History Node

0.29.1

History Node

0.29.0

History Node

0.28.1

History Node

0.28

History Node

0.27

History Node

0.26

History Node

0.25

History Node

0.24

History Node

0.23

History Node

0.22

History Node

0.21

History Node

0.20

History Node

0.19

History Node

0.18

History Node

0.17

This version
History Node

0.16

History Node

0.15

History Node

0.14

History Node

0.13

History Node

0.12

History Node

0.11

History Node

0.1

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
pygerduty-0.16.tar.gz (6.8 kB) Copy SHA256 hash SHA256 Source None Oct 1, 2013

Supported by

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