Metadata-Version: 2.1
Name: pluralkit
Version: 0.0.3
Summary: Asynchronous Python wrapper for PluralKit's API.
Home-page: https://github.com/almonds0166/pluralkit.py
Author: Madison Landry, Alyx Warner
Author-email: pkpy@mit.edu
License: MIT
Project-URL: Documentation, https://pluralkit.readthedocs.io/en/latest/
Project-URL: Issue tracker, https://github.com/almonds0166/pluralkit.py/issues
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: Topic :: Internet
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Utilities
Requires-Python: >=3.6.0
Description-Content-Type: text/markdown
Requires-Dist: aiohttp (>=3.7.4)
Requires-Dist: colour (>=0.1.5)
Requires-Dist: pytz (>=2021.1)
Provides-Extra: dev
Requires-Dist: Sphinx (==3.5.4) ; extra == 'dev'
Requires-Dist: sphinx-autodoc-typehints (==1.12.0) ; extra == 'dev'
Requires-Dist: sphinx-book-theme (==0.1.0) ; extra == 'dev'
Requires-Dist: mypy (==0.910) ; extra == 'dev'
Requires-Dist: types-pytz (==2021.1.0) ; extra == 'dev'
Requires-Dist: pytest (==6.2.4) ; extra == 'dev'
Requires-Dist: check-manifest (==0.46) ; extra == 'dev'
Requires-Dist: twine (==3.4.1) ; extra == 'dev'
Requires-Dist: wheel (>=0.36.2) ; extra == 'dev'

# pluralkit.py

Asynchronous Python wrapper for [PluralKit](https://pluralkit.me/)'s API. Created with [discord.py](https://github.com/Rapptz/discord.py) in mind.

Currently working on PluralKit's v1.0 API.

## Quick example

```python
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.

```bash
# 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](https://pluralkit.me/api/#authentication), but it's required for editing one's system or members or for accessing one's private system or member info.

## Links

* [PyPI link](https://pypi.org/project/pluralkit/)
* [Latest build of the docs](https://pluralkit.readthedocs.io/en/latest/)
* [pluralkit.py Discord support server](https://discord.gg/secvguatbC)
* [PluralKit support server](https://discord.gg/PczBt78)
* [PluralKit's API](https://pluralkit.me/)

## Todo

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


