Pygerduty Python Client for PagerDuty

Warnings

• breaking The PagerDuty API v1, which `pygerduty` primarily targets, was officially deprecated by PagerDuty in July 2017 and is no longer supported. The library's `v2` submodule (introduced later) might provide limited v2 compatibility, but the library is largely unmaintained for modern PagerDuty API usage.
  Fix: Consider migrating to an actively maintained PagerDuty Python client that fully supports API v2, such as `python-pagerduty` (official PagerDuty library) or `pypd`.
• deprecated The library lacks recent maintenance. The last PyPI release was in April 2020, and the GitHub repository shows no significant activity since then. It is effectively unmaintained.
  Fix: No direct fix for this library. Users should transition to alternative, actively maintained PagerDuty Python clients for new development and ongoing support.
• breaking Python 2 support is no longer relevant as Python 2 reached end-of-life. While older versions of `pygerduty` claimed Python 2.5+ compatibility, modern Python applications should use Python 3.6+.
  Fix: Ensure your environment uses Python 3.6 or newer. If you must interact with legacy PagerDuty API v1 endpoints and this specific library, be aware of potential compatibility issues with very recent Python 3 versions due to lack of updates.
• gotcha Authentication for the PagerDuty API requires both a subdomain (e.g., 'yourcompany' from 'yourcompany.pagerduty.com') and an API key. For PagerDuty API v2, the `From` header (an email address of a PagerDuty user) is often required for certain actions if an account-level API key is used.
  Fix: Always provide the correct subdomain and API key. When using PagerDuty API v2 (if using `pygerduty.v2`), ensure you understand the requirements for the `From` header and API key types as per PagerDuty's official API documentation.

Install

• pip install pygerduty Install stable version

Imports

• PagerDuty

  import pygerduty
  pager = pygerduty.PagerDuty("your_subdomain", "your_api_key")

  The PagerDuty class is typically accessed via the top-level package namespace after a simple import.
• PagerDuty (V2 API)

  import pygerduty.v2
  pager_v2 = pygerduty.v2.PagerDuty("your_subdomain", "your_api_key")

  For PagerDuty API v2 interactions, the client is exposed through the `v2` submodule.

Quickstart

This quickstart demonstrates how to instantiate a `pygerduty` client for the PagerDuty v1 API (default behavior) and fetch a list of schedules. It uses environment variables for authentication credentials.

import os
import pygerduty

# Ensure your PagerDuty subdomain and API key are set as environment variables
PD_SUBDOMAIN = os.environ.get('PD_SUBDOMAIN', 'your_subdomain_here')
PD_API_KEY = os.environ.get('PD_API_KEY', 'YOUR_API_KEY_HERE')

if not PD_SUBDOMAIN or not PD_API_KEY:
    print("Please set PD_SUBDOMAIN and PD_API_KEY environment variables.")
else:
    try:
        # Instantiate a PagerDuty client (targets v1 API by default)
        pager = pygerduty.PagerDuty(PD_SUBDOMAIN, PD_API_KEY)

        # List schedules (example using v1 API pattern)
        print(f"Fetching schedules for subdomain: {PD_SUBDOMAIN}")
        for schedule in pager.schedules.list():
            print(f"  - ID: {schedule.id}, Name: {schedule.name}")

        # For PagerDuty API v2 interactions (if implemented in your version/fork)
        # import pygerduty.v2
        # pager_v2 = pygerduty.v2.PagerDuty(PD_SUBDOMAIN, PD_API_KEY)
        # print("\nFetching users via v2 API (if supported by your client config):")
        # for user in pager_v2.users.list():
        #     print(f"  - ID: {user.id}, Name: {user.name}, Email: {user.email}")

    except Exception as e:
        print(f"An error occurred: {e}")
        print("Please check your PagerDuty subdomain, API key, and network connectivity.")