A Python IRC and API wrapper for Twitch.
Project description
An Asynchronous IRC/API Wrapper currently in Development for TwitchBots made in Python!
Documentation
Official Documentation: Click Here!
Support
For support using TwitchIO, please join the official support server on Discord.
Installation
The following commands are currently the valid ways of installing TwitchIO.
TwitchIO requires Python 3.6 or higher.
Windows
py -version -m pip install twitchio
Linux
python3 -m pip install twitchio
Getting Started
TwitchIO uses many endpoints which may require different tokens and IDs.
- IRC endpoints which require an OAuth token.
To get a token, log in to Twitch with the bot’s account and visit: https://twitchapps.com/tmi/
- HTTP endpoints which require a client ID.
To be documented.
- HTTP endpoints which require an OAuth token and certain scopes.
To be documented.
All 3 endpoints may be used at the same time. Otherwise, you may choose to use any or some of the endpoints.
Currently, TwitchIO’s development is at a phase which has emphasis on the IRC endpoint and creating a framework around it. Once this is implemented, the other 2 endpoints will be developed further.
A quick and easy bot example:
from twitchio.ext import commands
class Bot(commands.Bot):
def __init__(self):
super().__init__(irc_token='...', client_id='...', nick='...', prefix='!',
initial_channels=['...'])
# Events don't need decorators when subclassed
async def event_ready(self):
print(f'Ready | {self.nick}')
async def event_message(self, message):
print(message.content)
await self.handle_commands(message)
# Commands use a different decorator
@commands.command(name='test')
async def my_command(self, ctx):
await ctx.send(f'Hello {ctx.author.name}!')
bot = Bot()
bot.run()
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.