.rst .pdf

repository

Contents

Welcome to pluralkit.py’s documentation!

pluralkit.py is a Python wrapper for PluralKit’s API created with discord.py in mind.

If visiting here for the first time, check out the Getting Started page!

Contents

• Getting started
  • Prerequisites
  • Installing
    • Development
  • Basic concepts
    • Client
    • Token
    • Models
• API reference
  • Client
  • Models
    • System
    • SystemSettings
    • AutoproxySettings
    • SystemGuildSettings
    • Member
    • MemberGuildSettings
    • Group
    • Switch
    • Message
  • Primitives
    • SystemId
    • MemberId
    • GroupId
    • Birthday
    • Color
    • ProxyTag
    • ProxyTags
    • Timestamp
    • Timezone
  • Enumerations
    • AutoproxyMode
    • Privacy
  • Exceptions
    • PluralKitException
    • HTTPError
    • GenericBadRequest
    • NotFound
    • SystemNotFound
    • MemberNotFound
    • GroupNotFound
    • SwitchNotFound
    • MessageNotFound
    • GuildNotFound
    • Unauthorized
    • NotOwnSystem
    • NotOwnMember
    • NotOwnGroup
• Version history
  • Version related info
  • v1.1.0 (December 30, 2022)
  • v1.0.0 (June 10, 2022)
  • v0.1.2 (July 13, 2021)
    • New features
    • Improvements
  • v0.1.0 (July 12, 2021)
    • New features
    • Fixes
  • v0.0.1 (Jun 26, 2021)
    • New features

Deprecated: pluralkit.py’s API reference for PluralKit’s **v1** API

Links

• PyPI link

• pluralkit.py’s Discord support server

• PluralKit’s API

• PluralKit support server

Indices and tables

• Index

• Module Index

• Search Page

Getting started