python-pagerduty: Clients for PagerDuty’s APIs

External Resources

• GitHub Repository

• PyPI Project Page

• PagerDuty Developer Documentation

• PagerDuty API References

Table of Contents

• Changelog
• User Guide
  • Installation
  • Command Line Interface
  • Client Initialization
    • Authentication
    • Selecting a Client Class
    • Clients as Context Managers
    • The From Header
  • Obtaining OAuth Tokens
    • Performing an OAuth Exchange to Obtain an Access Token
    • Performing OAuth Token Refresh Automatically
  • Using Non-US Service Regions
  • Basic Usage Examples
    • REST API v2
    • Events API v2
  • Generic Client Features
  • URLs
  • Query Parameters
  • Requests and Responses
    • Data types
    • Resource Schemas
  • Entity Wrapping
    • Identifying Wrapped-entity Endpoints
    • Wrapped-entity-aware Functions
    • Special Cases
    • Examples
  • Pagination
    • Retrieving Large Historical Datasets
    • Non-Standard Pagination Styles
    • Performance and Completeness of Results
    • Updating, creating or deleting while paginating
  • Multi-updating
  • Error Handling
  • Logging
  • Using a Proxy Server
  • HTTP Retry Configuration
    • Default Behavior
    • Exponential Cooldown
    • Configuring Retry Behavior
• PDPYRAS Migration Guide
  • Client Classes
  • Exception Classes
• Module Reference
  • API Client Classes
    • ApiClient
    • OAuthTokenClient
    • RestApiV2BaseClient
    • RestApiV2Client
    • EventsApiV2Client
    • JiraCloudIntegrationApiClient
    • JiraServerIntegrationApiClient
    • MsTeamsIntegrationApiClient
    • SlackIntegrationApiClient
    • SlackIntegrationConnectionsApiClient
    • McpApiClient
    • ScimApiClient
  • AuthMethod Classes
    • AuthMethod
    • HeaderAuthMethod
    • BodyParameterAuthMethod
    • TokenAuthMethod
    • OAuthTokenAuthMethod
    • PassThruHeaderAuthMethod
    • RoutingKeyAuthMethod
    • ClientCredentialsAuthMethod
  • Errors
    • Error
    • HttpError
    • ServerHttpError
    • UrlError
  • Common Features
    • DATETIME_FMT
    • TEXT_LEN_LIMIT
    • TIMEOUT
    • datetime_intervals()
    • datetime_to_relative_seconds()
    • deprecated_kwarg()
    • http_error_message()
    • last_4()
    • normalize_url()
    • plural_name()
    • relative_seconds_to_datetime()
    • requires_success()
    • singular_name()
    • strftime()
    • strptime()
    • successful_response()
    • truncate_text()
    • try_decoding()
  • REST API v2 Helpers
    • CanonicalPath
    • EntityWrapping
    • EntityWrappingSpec
    • ITERATION_LIMIT
    • OAuthTokenAuthMethod
    • TokenAuthMethod
    • auto_json()
    • canonical_path()
    • endpoint_matches()
    • entity_wrappers()
    • infer_entity_wrapper()
    • is_path_param()
    • resource_url()
    • unwrap()
    • wrapped_entities()
• Contribution Guide
  • Initial Setup
  • Linting, Formatting and Testing
  • Adding Support for New API Endpoints
    • Adding a New Client Class
    • Updating the Canonical Path Set
    • Evaluating New REST API Endpoints
    • Adding Support for Antipattern Endpoints
    • Limitations to Pagination Support
  • Updating Documentation
  • Releasing a New Version
    • Perform end-to-end publish and installation testing
    • Merge changes and tag
    • Publishing