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.1.tar.gz (14.6 kB view details)

Uploaded Source

Built Distributions

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

Uploaded Source

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

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for asynctwitch-4.2.1.tar.gz
Algorithm Hash digest
SHA256 6f994ddc54358ea6daf09f0c65ed26060e91ea00083bb0393cc12b247096f154
MD5 27a3d140c947ea18625d281e8e688990
BLAKE2b-256 79ac7f1846d6a35b6d3d9a5edb65a1018427e1bd65db1d547bca45488289df96

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for asynctwitch-4.2.1-py3.6.egg
Algorithm Hash digest
SHA256 837ba00b153d08aaec1403602a77eda762f6c1bbad726890a42a9214d7e83d81
MD5 77a2ddd7228594bbca0cc5d24b6f395b
BLAKE2b-256 87725f7171886f7e0067c7a7d19426821550ee17660a4541cda2cc0f4ba1ed3e

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for asynctwitch-4.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 555f970f9029bef71f652d1ebbaf1b5c2cfdab0b581b3d2b4ac5535a3ce29fbb
MD5 9ccf659373237f0323e40d8a7de04e03
BLAKE2b-256 5fabb653a1673ad423d35cb425ef642ea9541baa387bf4128df8f11fb2f269bf

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