Skip to main content

Asynchronous Python wrapper for PluralKit's API.

Project description

pluralkit.py

Asynchronous Python wrapper for PluralKit's API. Created with discord.py in mind.

Currently working on PluralKit's v1.0 API.

Quick example

from pluralkit import Client

pk = Client()

async for member in pk.get_members("abcde"):
   # list members of the system with ID ``abcde``
   print(f"{member.name} (`{member.id}`)")

Installing

Python 3.6 or higher is required.

# linux/MacOS
python3 -m pip install -U pluralkit

# windows
py -3 -m pip install -U pluralkit

Token

The client can be used without one's PluralKit authorization token, but it's required for editing one's system or members or for accessing one's private system or member info.

Links

Todo

  • Tidy up error handling
  • Test timezone mechanics
  • Prepare for API v2

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pluralkit-0.0.3.tar.gz (30.6 kB view hashes)

Uploaded Source

Built Distribution

pluralkit-0.0.3-py3-none-any.whl (3.0 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page