Skip to main content

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/

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)
    • BEING DEVELOPED, NOTHING HERE IS DONE. WILL RAISE AN ERROR.
    • .name (str)
    • .id (str)
    • .subdomain (str)
    • .aliases (list(class UserAlias))
      • ??? (being developed)
    • ??? (being developed)

License

This project is licensed under the MIT License. See the LICENSE file for details.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

cardboard.py-0.0.1.tar.gz (5.2 kB view details)

Uploaded Source

Built Distribution

cardboard.py-0.0.1-py3-none-any.whl (5.6 kB view details)

Uploaded Python 3

File details

Details for the file cardboard.py-0.0.1.tar.gz.

File metadata

  • Download URL: cardboard.py-0.0.1.tar.gz
  • Upload date:
  • Size: 5.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.6

File hashes

Hashes for cardboard.py-0.0.1.tar.gz
Algorithm Hash digest
SHA256 18d92546d07bc79c3177e99c6507db74df889e4a459b4d46b615868fcd4c5451
MD5 991401ee02097ad355a1883d1a0dd1fe
BLAKE2b-256 204efa41835faadf68b92286f5739d07608ef6c3ac242a52f55c17c56c45be9e

See more details on using hashes here.

File details

Details for the file cardboard.py-0.0.1-py3-none-any.whl.

File metadata

File hashes

Hashes for cardboard.py-0.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 4646dfff7cd596483663131494302732633f98f9bc531a477fb2f31295f514dd
MD5 769f1e1cf8d090fdc5539c0917000980
BLAKE2b-256 64575e9db73109408eb7529711d89c907a374e75258656d7fe4284cf6fa4fd7e

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page