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.1.0.tar.gz (13.5 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.1.0-py3.5.egg (34.3 kB view details)

Uploaded Egg

asynctwitch-4.1.0-py3-none-any.whl (16.0 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for asynctwitch-4.1.0.tar.gz
Algorithm Hash digest
SHA256 a9a6261db93ee21e863045d606df25ca6748d60dea371c9241a6cf302dc99325
MD5 dc37acb4150f67cca069f8bd3fc88230
BLAKE2b-256 68200b051f8d5a391069cada66fb03433e7b70737af2a0fbaa1ba5623d5b0449

See more details on using hashes here.

File details

Details for the file asynctwitch-4.1.0-py3.5.egg.

File metadata

File hashes

Hashes for asynctwitch-4.1.0-py3.5.egg
Algorithm Hash digest
SHA256 0cbc8222bfc5aad66fb033fb72345761ba155c1f5798d5dbb80dc41db9c2984e
MD5 c2742464c6850f5b31d77acd710b8b40
BLAKE2b-256 ba7e50ad2648742cb985424ca97f4e86dbac6feae02fcd4b71e83f0d55787c8c

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for asynctwitch-4.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 1c9cdaef7b34703e3fcce329c055cecec0ad531f0f4d537af35133a23a6c3c30
MD5 cc2316808123ba4e4f6f32dac9e2e623
BLAKE2b-256 071403ba793cc1631c6100ee9f43607dee56a30d43c91e309db88d8fdeffd19d

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