Python Client Library for PagerDuty's REST API
Project description
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
Tested on Python 2.7, or >= 3.3.
Known to work on Python 2.6.
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 all schedules associated with a user:
user = pager.users.show('PDSKF08')
for schedule in user.schedules.list():
print schedule.id, schedule.name
# PDSARUD Ops
# PTDSKJH Support
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)
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
File details
Details for the file pygerduty-0.35.2.tar.gz.
File metadata
- Download URL: pygerduty-0.35.2.tar.gz
- Upload date:
- Size: 9.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 8db75af2538b1a9ae2937574eb69e36eab765b44a643f28549e152676d3df8b0 |
|
| MD5 | a4d1dbe63211517141f5a2023a1a6bd1 |
|
| BLAKE2b-256 | 2add8538be5ea86dbc684b11f3db721223b68b3548b6eea5645cec51eb7d00db |
