Skip to main content

A wrapper for the Capncord API.

Project description

capncord.py

capncord.py is an API wrapper for Discord written in Python.

Installing

To install the library, run the following command:

pip install capncord.py

Depending on your environment, the command may be slightly different. If you're having trouble installing the library, familiarize yourself with how pip works on your platform first.

Tutorial

To create a bot, subclass capncord.Bot and overload on_ready and on_message.

Bot

The Bot class supports the methods async def wait_for(event: str, check: Optional[function] = None, timeout: Optional[int] = None, async def get_message(id: int) -> Message, async def history() -> List[Message] and async def get_channel(id: int) -> Channel.

history() returns a list of messages sent in all channels with the most recent messages at the start of the list.

It also has the attributes loop: asyncio.BaseEventLoop, session: aiohttp.ClientSession and user: User.

Message

The Message class has the attributes id: int, created_at: datetime.datetime, content: str, author: User and channel: Channel.

Channel

The Channel class supports the methods async def send(content: str) and async def history() -> List[Message].

history() returns a list of messages sent in this channel with the most recent messages at the start of the list.

It also has the attribute id.

User

The User class supports str.

It also has the attributes await User.name and await User.messages_sent.

Requirements

  • Python 3.5.3+
  • aiohttp library
  • websockets library

Usually pip will handle these for you.

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

capncord.py-0.2.1.tar.gz (3.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

capncord.py-0.2.1-py3-none-any.whl (8.1 kB view details)

Uploaded Python 3

File details

Details for the file capncord.py-0.2.1.tar.gz.

File metadata

  • Download URL: capncord.py-0.2.1.tar.gz
  • Upload date:
  • Size: 3.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.20.1 setuptools/40.6.2 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.6.7

File hashes

Hashes for capncord.py-0.2.1.tar.gz
Algorithm Hash digest
SHA256 52f910fae463ad2a4af839d054817f7c06476c9278f9f7693f7d6e6e3e3f30f7
MD5 e98d927492b036a409ccec6ecfecb621
BLAKE2b-256 da189fa243cbf4a01926452188dec52288b2f5338c6013aebdf6b211f8aa353d

See more details on using hashes here.

File details

Details for the file capncord.py-0.2.1-py3-none-any.whl.

File metadata

  • Download URL: capncord.py-0.2.1-py3-none-any.whl
  • Upload date:
  • Size: 8.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.20.1 setuptools/40.6.2 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.6.7

File hashes

Hashes for capncord.py-0.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 8411e026bda0b5b7d58b9140e6d5c95258041f2b723019e39fa419d2e709e739
MD5 d467492ea6854937d22d47054e66729a
BLAKE2b-256 fa990387c51b94a0f880d36b39d168f1d803bafc4371669521fc07071f72ce84

See more details on using hashes here.

Supported by

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