API wrapper for https://cardboard.ink/api/v1/
Project description
cardboard.py
cardboard.py is a Python library for interacting with the cardboard API.
PyPi: https://pypi.org/project/cardboard.py/
Installation
You can install the cardboard.py library using pip:
pip install cardboard.py
Usage
Initialize the Cardboard or CardboardAsync class. Make sure to pass client_secret
and client_id
.
You can now use the client to make requests.
Example
# Python Example
Async Example
# Python Async Example
Documentation
For detailed documentation on the Cardboard API, read https://www.guilded.gg/CardBoard/groups/3y446Rmz/channels/4539a4f9-fb51-4a23-b01-0fcaeaf062d3/docs/374610
For detailed documentation on how to use the cardboard.py library, please wait while we write it lol.
Methods
A list of methods you can call with either Cardboard or CardboardAsync.
.revoke_token(token:str)
(bool).get_token(code:str)
(class AuthToken).token
(str).token_type
(str).refresh_token
(str).expires_in
(int)._raw
(dict)
.refresh_token(refresh_token:str)
(class AuthToken).token
(str).token_type
(str).refresh_token
(str).expires_in
(int)._raw
(dict)
.get_user(token:str)
(class User).name
(str).id
(str).subdomain
(str).aliases
(list(class UserAlias)).alias
(str|None).discriminator
(str|None).name
(str).createdAt
(datetime).editedAt
(datetime)._raw_createdAt
(str)._raw_editedAt
(str).userId
(str).gameId
(int).socialLinkSource
(str|None).socialLinkHandle
(str|None).additionalInfo
(dict).playerInfo
(dict|None)._raw
(dict)
.avatar
(str).banner
(str).status
(class UserStatus).text
(str|None).reaction_id
(int|None)._raw
(dict)._raw_text
(dict)._raw_reaction
(dict)
.moderationStatus
(str|None).aboutInfo
(class userAbout).bio
(str|None).tagline
(str|None)._raw
(dict)
.userTransientStatus
(str|None)._raw
(dict)
License
This project is licensed under the MIT License. See the LICENSE file for details.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for cardboard.py-0.0.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1be9dfa580b4053e0a2c5ff5cc8e42732426cae29dc1c3cc3c310c4c14382dc0 |
|
MD5 | f4055b88fcc6e1d8da9f83f463daac2e |
|
BLAKE2b-256 | ecf69dfb9c101dbe9d0c7d04518aefdb5ffe0814855050b758c9d6cfe00fff5b |