pluralkit.py
Python wrapper for PluralKit's API.
Installing
Python 3.6 or higher is required.
# linux/macOS
python3 -m pip install -U pluralkit
# windows
py -3 -m pip install -U pluralkit
Quick examples
Provided a system's authorization token, the examples below print the system description and list the system's members.
Async usage
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())
Synchronous usage
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}`)")
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.
Contributors ✨
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 💻🐛 |
Links
1 maintainer
Metadata
1 maintainer
Release files for pluralkit 1.2.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| pluralkit-1.2.1.tar.gz | 48.5 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| pluralkit-1.2.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 86.8 kB
Release files / pluralkit-1.2.1.tar.gz
| Download URL | pluralkit-1.2.1.tar.gz |
|---|---|
| Size | 48.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
ed49e2b6dc6fb9acf489be8dccf6975d328f3946f69ee41e9fec1b9df06bb6af
|
|
BLAKE2b-256 checksum How to use checksums |
fb7bbb21b4524d9c69c0c5b87031006cf6da7f8addf79383244469e0e0020316
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.13.1
|
Release files / pluralkit-1.2.1-py3-none-any.whl
| Download URL | pluralkit-1.2.1-py3-none-any.whl |
|---|---|
| Size | 38.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
feca40875f479ee1000f85314003cdcfa3f2757c32578ba905d425e56cb80baa
|
|
BLAKE2b-256 checksum How to use checksums |
f00bd340b855a6fe7511b13103530b4dfead86d6a09e73846d588b8a9e48a324
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.13.1
|
