A client in Python for PagerDuty's v2 API.
Yes, how do. The ultimate question in quickstart.
import pypd
pypd.api_key = "SOMESECRETAPIKEY"
# fetch some dataz
incidents = pypd.Incident.find(maximum=10)
# how do dataz?
ep = pypd.EscalationPolicy.find_one()
print ep['id']
print ep.get('name')
print ep.json # not a string, a json-compat dict
print ep.__json__() # a json encoded string, json encoder interface compat
print ep._data # raw data, best not to access it this way!
# nice embedded property things
incident = pypd.Incident.find_one()
log_entries = incident.log_entries()
# find users
user = pypd.User.find_one(email="jdc@pagerduty.com")
# create an event
pypd.Event.create(data={
'service_key': 'YOUR_INTEGRATION_KEY',
'event_type': 'trigger',
'description': 'this is a trigger event!',
'contexts': [
{
'type': 'link',
'href': 'http://acme.pagerduty.com',
'text': 'View on PD',
},
],
})All models should be complete CR-D complete, with the missing update method. Soon to be fixed.
If you need some embedded properties that don't exist, take a look at LogEntry or Incident model classes.
Run all the tests (unittests only currently) with:
python test/runtests.py [-vvv]An asynchronous port of this library for Twisted exists txpypd and is on it's way to catching up now.
All help is welcome. Unittests are great to have more of. Suggestions welcome.
All the code in this distribution is Copyright (c) 2016 PagerDuty.
pypd is availabe under the MIT License. The LICENSE file has the complete details.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
The LICENSE file has the complete details.