Peony’s documentation

Peony is an asynchronous Twitter API client for Python 3.6+.

If you encounter an error after updating Peony check out the Breaking changes section.

Usage

• Quickstart
  • Installation
  • Authorize your client
  • Getting started
• How to access the API
  • Access the response data of a REST API endpoint
  • Access the response data of a Streaming API endpoint
• Upload medias
• Iterators
  • Cursor iterators
  • Max_id iterators
  • Since_id iterators
• Tasks
  • Init tasks
  • The task decorator
• Streams

Advanced Usage

• Advanced installation
  • python-magic
  • aiofiles
  • aiohttp
  • Minimal installation
• Accessing an API using a different API version
  • Create a client with a custom api version
  • Add a version when creating the request
• Use the Application only authentication
• The loads function used when decoding responses
  • I don’t like this, how can I change this
• Handle errors for every request
• Use an already created session

Changes

• Breaking changes
  • Changes in Peony 2.0
    • Twitter exceptions inherit from HTTP exceptions
    • PeonyClient doesn’t have a twitter_configuration attribute anymore
  • Changes in Peony 1.1
    • Error Handlers must inherit from ErrorHandler
    • PeonyClient’s properties are now awaitables
    • Init tasks don’t exist anymore

Modules

• peony package
  • Subpackages
    • peony.commands package
      • peony.commands.event_handlers module
      • peony.commands.event_types module
      • peony.commands.tasks module
      • peony.commands.utils module
      • Module contents
  • peony.api module
  • peony.client module
  • peony.exceptions module
  • peony.general module
  • peony.iterators module
  • peony.oauth module
  • peony.oauth_dance module
  • peony.requests module
  • peony.stream module
  • peony.utils module

Indices and tables

• Index
• Module Index