cardboard.py 0.0.6

API wrapper for https://cardboard.ink/api/v1/

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 secret and client_id.

You can now use the client to make requests.

Examples

These examples will use Flask. Install it with pip install Flask

# Python Example
from flask import Flask, request, redirect, url_for, session, Response
from cardboard import Cardboard

app = Flask(__name__)
cb = Cardboard(client_id='', secret='') # get these at https://cardboard.ink
app.secret_key = 'hi' # set this to something secure, please.

@app.route('/login')
def login():
    args = request.args
    code = args.get('code')
    if not code:
        return redirect(cb.app_url)
    try:
        token = cb.get_token(code)
    except:
        return redirect(cb.app_url)
    session['cardboard_token'] = token.token
    return redirect(url_for('dashboard'))

@app.route('/dashboard')
def dashboard():
    token = session.get('cardboard_token')
    if not token:
        return redirect(cb.app_url)
    user = cb.get_user(token)
    return Response(f'{user.name} (user id {user.id})', mimetype='text/plain')

if __name__ == '__main__':
    app.run('0.0.0.0', port=5000)

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.