Python wrapper for PluralKit's API.
Python 3.6 or higher is required.
# linux/macOS
python3 -m pip install -U pluralkit
# windows
py -3 -m pip install -U pluralkit
Provided a system's authorization token, the examples below print the system description and list the system's members.
pluralkit.py was created with discord.py in mind, and so the default implementation is asynchronous.
from pluralkit import Client
import asyncio
pk = Client("token") # your token here
async def main():
system = await pk.get_system()
print(system.description)
members = pk.get_members()
async for member in members:
print(f"{member.name} (`{member.id}`)")
loop = asyncio.get_event_loop()
loop.run_until_complete(main())
Blocking execution may be specified with the client argument async_mode=False
.
from pluralkit import Client
pk = Client("token", async_mode=False)
system = pk.get_system()
print(system.description)
members = pk.get_members()
for member in members:
print(f"{member.name} (`{member.id}`)")
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.
Thanks to these wonderful people (emoji key) and users in the Discord who actively supported development:
Alyx 💻🤔🚇 |
Kotocade 💻📖🤔🚧📆💬 |
Ashton Power 💻📓 |
System in a Box 🐛 |
Warmth System 💻🐛 |