Skip to main content

Asynchonous wrapper for twitch IRC3

Project description

AsyncTwitch
=======================

This library is used to asynchronously interact with twitch chat.

----

Requirements:

- Create a twitch.tv account
- Get an Oauth token

----

How to use:

```python
import asynctwitch

# Use the pre-made CommandBot, to handle messages yourself, use asynctwitch.Bot and handle event_message.
bot = asynctwitch.CommandBot(
user = "Your_bot_twitch_username",
oauth = "Your_twitch_oauth_token", # oauth:1234567890abcdefghijklmnopqrst
channel = "channel_name", # Defaults to Twitch
prefix = "your_prefix_here", # Defaults to '!'
)



# Example command:
@bot.command('example', alias=['moreexample','anothaone'], desc='example command')
async def example(message, word1:str, number1:int, rest:str):
bot.say('wow')



# Example subcommand:
@bot.command('say')
async def say(m, subcommand:str):
pass

@say.subcommand('this')
async def this(m):
bot.say("that")

bot.start()
```

To use a config file instead, use
```python
asynctwitch.Bot(config="your_settings.ini")
# or
asynctwitch.CommandBot(config="your_settings.ini")
```
see config.ini for an example file


It's also possible to handle messages your own way, just use

```python
@bot.override
async def event_message(message):
# your handling here
```

The same applies to all bot.event_X functions.


To use `await bot.play_file('file.mp3')`, ffprobe, ffmpeg and ffplay have to be installed. They can be found on the ffmpeg website.

To use `await bot.play_ytdl('song')`, youtube_dl has to be installed. Use `pip install youtube_dl` to install it.
You will also need the requirements for `bot.play_file`


These examples use the `async/await` syntax added in python 3.5, to use this code in 3.4 use `@asyncio.coroutine` and `yield from` instead.
THIS DOES NOT WORK WITH PYTHON VERSIONS BELOW 3.4!


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

asynctwitch-4.2.0.tar.gz (14.6 kB view details)

Uploaded Source

Built Distributions

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

asynctwitch-4.2.0-py3.6.egg (36.7 kB view details)

Uploaded Egg

asynctwitch-4.2.0-py3-none-any.whl (17.3 kB view details)

Uploaded Python 3

File details

Details for the file asynctwitch-4.2.0.tar.gz.

File metadata

  • Download URL: asynctwitch-4.2.0.tar.gz
  • Upload date:
  • Size: 14.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for asynctwitch-4.2.0.tar.gz
Algorithm Hash digest
SHA256 bb1ec468e70062ecb5352109887e2ca4299ab7eadc2eb5d6de88f5dbbc1ebf11
MD5 6fb38bde616c383517fad109d8f2fe33
BLAKE2b-256 f387ed40892addf2a09167233a0f187753179c0b77be4b69de9c12d598f163bb

See more details on using hashes here.

File details

Details for the file asynctwitch-4.2.0-py3.6.egg.

File metadata

File hashes

Hashes for asynctwitch-4.2.0-py3.6.egg
Algorithm Hash digest
SHA256 8f9316c8c3771c949517f126ce980b95c5a6b9ef75e934a0219fe13aa537e265
MD5 2b319a53b02f024b94ff7a4b46ff247f
BLAKE2b-256 f869bd80b53fb1fbc61052bf69e3baca6a37f287cef750f23fcd4919ec3884bc

See more details on using hashes here.

File details

Details for the file asynctwitch-4.2.0-py3-none-any.whl.

File metadata

File hashes

Hashes for asynctwitch-4.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b1fcc64e066e46ec3e6070f25183cc5a7312e7c5e355ab5d8870b1fb25d8808f
MD5 9e21cbdc2d7d4a58c38dd573b0a1df0f
BLAKE2b-256 345b953fb97e9105f87925515837e06ec22d3b8077e8321fbeb37f2ef5d3b871

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