Giter Club home page Giter Club logo

pluralkit.py's Introduction

pluralkit.py

PyPi Version Documentation Status Discord server invite

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

๐Ÿ›

Gem

๐Ÿ’ป๐Ÿ›

Links

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.