WordPress REST API Python Client

A comprehensive Python library for interacting with the WordPress REST API.

Features

• Complete support for WordPress REST API endpoints

• Multiple authentication methods (Application Passwords, Basic Auth, OAuth1)

• Intuitive interface for common WordPress operations (posts, pages, media, etc.)

• Support for custom taxonomies and post types

• Custom fields (post meta) management

• Robust error handling with specific exception types

• Full typing support for better IDE integration

• Automatic retries for failed requests

Contents

User Guide:

• Installation
  • Stable release
  • From sources
• Usage
  • Authentication Methods
  • Working with Posts
  • Working with Media
  • Error Handling
• Examples
  • Basic Usage
  • Working with Posts
  • Working with Custom Post Types
  • Error Handling
  • Working with Media
  • More Examples
• Deployment
  • Preparing for Release
  • Building the Package
  • Publishing to PyPI
  • Updating Documentation on Read the Docs
  • Tagging Releases on GitHub
  • Automating with GitHub Actions

API Reference:

• Client
  • WPClient
• Authentication
  • BasicAuth
  • ApplicationPasswordAuth
  • OAuth1
• Exceptions
  • WPAPIError
  • WPAPIAuthError
  • WPAPIRequestError
  • WPAPIRateLimitError
  • WPAPINotFoundError
  • WPAPIPermissionError
  • WPAPIValidationError
  • WPAPIBadRequestError
  • WPAPIServerError
  • WPAPITimeoutError
  • WPAPIConnectionError
• Endpoints
  • Base Endpoint
  • Posts
  • Pages
  • Media
  • Users
  • Comments
  • Categories
  • Tags
  • Taxonomies
  • Custom Fields
  • Custom Post Types
  • Block Patterns
  • Settings

Development:

• Contributing
• Authors
• History

Indices and tables

• Index

• Module Index

• Search Page