PagerDuty Python API Client

Warnings

• breaking The 'pypd' library is community-supported and has not been updated since March 2018. For new projects, PagerDuty itself recommends using the more actively maintained `python-pagerduty` library, which is a successor to other PagerDuty Python clients like `pdpyras`.
  Fix: Consider migrating to `python-pagerduty` for new development or if active maintenance and new features are required. The migration path from `pypd` may require code changes due to different API client design.
• gotcha Authentication requires a PagerDuty API token (v2) and potentially an API URL. It is crucial to handle these credentials securely, ideally through environment variables (e.g., `PD_API_KEY`, `PD_API_URL`) rather than hardcoding them.
  Fix: Store `PD_API_KEY` and `PD_API_URL` as environment variables and use `pypd.from_env()` for initialization. Never hardcode sensitive API keys directly in your source code.
• gotcha The library name 'pypd' can easily be confused with 'pypdf' or 'PyPDF2', which are popular Python libraries for PDF file manipulation. Ensure you are installing and importing the correct library for PagerDuty API interactions.
  Fix: Double-check `pip install pypd` and import statements (`import pypd`) to confirm you are using the PagerDuty client, and not inadvertently pulling in a PDF library.

Install

• pip install pypd Install with pip

Imports

• pypd

  import pypd

  The primary import for accessing the client and its methods.

Quickstart

This quickstart demonstrates how to initialize the pypd client using environment variables for authentication and then fetch a PagerDuty incident by its ID. It highlights the recommended practice of configuring API keys securely via environment variables.

import pypd
import os

# Configure API key either directly or from environment variables
# It's recommended to use environment variables for security.
# export PD_API_KEY='YOUR_PAGERDUTY_API_KEY'
# export PD_API_URL='https://api.pagerduty.com'

# Option 1: Set directly (less secure for production)
# pypd.api_key = os.environ.get('PD_API_KEY', 'YOUR_PAGERDUTY_API_KEY')
# pypd.api_url = os.environ.get('PD_API_URL', 'https://api.pagerduty.com')

# Option 2: Initialize from environment variables (recommended)
pypd.from_env()

# Example: Fetch an incident by ID
try:
    # Replace 'YOUR_INCIDENT_ID' with an actual incident ID
    incident_id = os.environ.get('PAGERDUTY_TEST_INCIDENT_ID', 'YOUR_INCIDENT_ID')
    if incident_id == 'YOUR_INCIDENT_ID':
        print("Please set PAGERDUTY_TEST_INCIDENT_ID environment variable or replace 'YOUR_INCIDENT_ID' in code.")
    else:
        incident = pypd.Incident.fetch(id=incident_id)
        print(f"Fetched incident: {incident['title']} (ID: {incident['id']})")
        # Example: Print a few details
        print(f"Status: {incident['status']}")
        print(f"Urgency: {incident['urgency']}")
except Exception as e:
    print(f"Error fetching incident: {e}")
    print("Ensure PD_API_KEY and PD_API_URL are set correctly and the incident ID is valid.")