.. image:: https://raw.githubusercontent.com/TwitchIO/TwitchIO/master/logo.png
:align: center
.. image:: https://img.shields.io/badge/Python-3.7%20%7C%203.8%20%7C%203.9-blue.svg
:target: https://www.python.org
.. image:: https://img.shields.io/github/license/TwitchIO/TwitchIO.svg
:target: ./LICENSE
.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
:target: https://github.com/psf/black
.. image:: https://img.shields.io/pypi/dm/twitchio?color=black
:target: https://pypi.org/project/twitchio
:alt: PyPI - Downloads
TwitchIO is an asynchronous Python wrapper around the Twitch API and IRC, with a powerful command extension for creating Twitch Chat Bots. TwitchIO covers almost all of the new Twitch API and features support for commands, PubSub, Webhooks, and EventSub.
Documentation
---------------------------
For the Official Documentation: `Click Here! <https://twitchio.dev/>`_
Support
---------------------------
For support using TwitchIO, please join the official `support server
<https://discord.gg/RAKc3HF>`_ on `Discord <https://discord.com/>`_.
|Discord|
.. |Discord| image:: https://img.shields.io/discord/490948346773635102?color=%237289DA&label=Pythonista&logo=discord&logoColor=white
:target: https://discord.gg/RAKc3HF
Installation
---------------------------
TwitchIO requires **Python 3.7+**. You can download the latest version of Python `here <https://www.python.org/downloads/>`_.
**Windows**
.. code:: sh
py -m pip install -U twitchio
**Linux**
.. code:: sh
python -m pip install -U twitchio
Access Tokens
---------------------------
Visit `Token Generator <https://twitchtokengenerator.com/>`_ for a simple way to generate tokens for use with TwitchIO.
Getting Started
---------------------------
A simple Chat Bot.
.. code:: python
from twitchio.ext import commands
class Bot(commands.Bot):
def __init__(self):
# Initialise our Bot with our access token, prefix and a list of channels to join on boot...
super().__init__(token='ACCESS_TOKEN', prefix='?', initial_channels=['...'])
async def event_ready(self):
# We are logged in and ready to chat and use commands...
print(f'Logged in as | {self.nick}')
print(f'User id is | {self.user_id}')
@commands.command()
async def hello(self, ctx: commands.Context):
# Send a hello back!
await ctx.send(f'Hello {ctx.author.name}!')
bot = Bot()
bot.run()
Contributing
---------------------------
TwitchIO currently uses the `Black <https://black.readthedocs.io/en/stable/>`_ formatter to enforce sensible style formatting.
Before creating a Pull Request it is encouraged you install and run black on your code.
The Line Length limit for TwitchIO is **120**.
For installation and usage of Black visit: `Black Formatter <https://black.readthedocs.io/en/stable/usage_and_configuration/>`_
For integrating Black into your IDE visit: `Black IDE Usage <https://black.readthedocs.io/en/stable/integrations/editors.html>`_
Special Thanks
---------------------------
Thank you to all those who contribute and help TwitchIO grow.
Special thanks to:
`LostLuma (Lilly) <https://github.com/LostLuma>`_
`Harmon <https://github.com/Harmon758>`_
`Tom <https://github.com/IAmTomahawkx>`_
`Tesence <https://github.com/tesence>`_
`Adure <https://github.com/Adure>`_
`Scragly <https://github.com/scragly>`_
`Chillymosh <https://github.com/chillymosh>`_
If I have forgotten anyone please let me know <3: `EvieePy <https://github.com/EvieePy>`_
Raw data
{
"_id": null,
"home_page": "https://github.com/TwitchIO/TwitchIO",
"name": "twitchio",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": null,
"author": "TwitchIO",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/de/61/3f177d7e48af2816bd7bc639a7d5c4f2fa0ff3ae46faf36754b3c3676de9/twitchio-2.10.0.tar.gz",
"platform": null,
"description": ".. image:: https://raw.githubusercontent.com/TwitchIO/TwitchIO/master/logo.png\n :align: center\n \n \n.. image:: https://img.shields.io/badge/Python-3.7%20%7C%203.8%20%7C%203.9-blue.svg\n :target: https://www.python.org\n\n\n.. image:: https://img.shields.io/github/license/TwitchIO/TwitchIO.svg\n :target: ./LICENSE\n\n\n.. image:: https://img.shields.io/badge/code%20style-black-000000.svg\n :target: https://github.com/psf/black\n\n.. image:: https://img.shields.io/pypi/dm/twitchio?color=black\n :target: https://pypi.org/project/twitchio\n :alt: PyPI - Downloads\n\n\nTwitchIO is an asynchronous Python wrapper around the Twitch API and IRC, with a powerful command extension for creating Twitch Chat Bots. TwitchIO covers almost all of the new Twitch API and features support for commands, PubSub, Webhooks, and EventSub.\n\nDocumentation\n---------------------------\nFor the Official Documentation: `Click Here! <https://twitchio.dev/>`_\n\nSupport\n---------------------------\nFor support using TwitchIO, please join the official `support server\n<https://discord.gg/RAKc3HF>`_ on `Discord <https://discord.com/>`_.\n\n|Discord|\n\n.. |Discord| image:: https://img.shields.io/discord/490948346773635102?color=%237289DA&label=Pythonista&logo=discord&logoColor=white\n :target: https://discord.gg/RAKc3HF\n \nInstallation\n---------------------------\nTwitchIO requires **Python 3.7+**. You can download the latest version of Python `here <https://www.python.org/downloads/>`_.\n\n**Windows**\n\n.. code:: sh\n\n py -m pip install -U twitchio\n\n**Linux**\n\n.. code:: sh\n\n python -m pip install -U twitchio\n\nAccess Tokens\n---------------------------\nVisit `Token Generator <https://twitchtokengenerator.com/>`_ for a simple way to generate tokens for use with TwitchIO.\n\nGetting Started\n---------------------------\nA simple Chat Bot.\n\n.. code:: python\n\n from twitchio.ext import commands\n\n\n class Bot(commands.Bot):\n\n def __init__(self):\n # Initialise our Bot with our access token, prefix and a list of channels to join on boot...\n super().__init__(token='ACCESS_TOKEN', prefix='?', initial_channels=['...'])\n\n async def event_ready(self):\n # We are logged in and ready to chat and use commands...\n print(f'Logged in as | {self.nick}')\n print(f'User id is | {self.user_id}')\n\n @commands.command()\n async def hello(self, ctx: commands.Context):\n # Send a hello back!\n await ctx.send(f'Hello {ctx.author.name}!')\n\n\n bot = Bot()\n bot.run()\n\n\nContributing\n---------------------------\nTwitchIO currently uses the `Black <https://black.readthedocs.io/en/stable/>`_ formatter to enforce sensible style formatting.\n\n\nBefore creating a Pull Request it is encouraged you install and run black on your code.\n\nThe Line Length limit for TwitchIO is **120**.\n\n\nFor installation and usage of Black visit: `Black Formatter <https://black.readthedocs.io/en/stable/usage_and_configuration/>`_\n\nFor integrating Black into your IDE visit: `Black IDE Usage <https://black.readthedocs.io/en/stable/integrations/editors.html>`_\n\nSpecial Thanks\n---------------------------\nThank you to all those who contribute and help TwitchIO grow.\n\nSpecial thanks to:\n\n`LostLuma (Lilly) <https://github.com/LostLuma>`_\n\n`Harmon <https://github.com/Harmon758>`_\n\n`Tom <https://github.com/IAmTomahawkx>`_\n\n`Tesence <https://github.com/tesence>`_\n\n`Adure <https://github.com/Adure>`_\n\n`Scragly <https://github.com/scragly>`_\n\n`Chillymosh <https://github.com/chillymosh>`_\n\nIf I have forgotten anyone please let me know <3: `EvieePy <https://github.com/EvieePy>`_\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "An asynchronous Python IRC and API wrapper for Twitch.",
"version": "2.10.0",
"project_urls": {
"Homepage": "https://github.com/TwitchIO/TwitchIO"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4bbe49d93b0e13dad69a636e550a7b96a5208af9a91100f9b142a363882e0c4c",
"md5": "bdfb91c425dff90681014f4f78e48448",
"sha256": "7aa0b6950dad90feeb04b03fd10d3e4292fa8a7c2e7aea6b2fd6686bc5425fb2"
},
"downloads": -1,
"filename": "twitchio-2.10.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "bdfb91c425dff90681014f4f78e48448",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 143761,
"upload_time": "2024-06-25T14:47:20",
"upload_time_iso_8601": "2024-06-25T14:47:20.630943Z",
"url": "https://files.pythonhosted.org/packages/4b/be/49d93b0e13dad69a636e550a7b96a5208af9a91100f9b142a363882e0c4c/twitchio-2.10.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "de613f177d7e48af2816bd7bc639a7d5c4f2fa0ff3ae46faf36754b3c3676de9",
"md5": "a0fd2a417099443f111fe31263cfa271",
"sha256": "3ae5e17b3764eff24ad7d12decb473c9d34f18510b5d705e0bbe6fcf0b06fd75"
},
"downloads": -1,
"filename": "twitchio-2.10.0.tar.gz",
"has_sig": false,
"md5_digest": "a0fd2a417099443f111fe31263cfa271",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 114393,
"upload_time": "2024-06-25T14:47:22",
"upload_time_iso_8601": "2024-06-25T14:47:22.463411Z",
"url": "https://files.pythonhosted.org/packages/de/61/3f177d7e48af2816bd7bc639a7d5c4f2fa0ff3ae46faf36754b3c3676de9/twitchio-2.10.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-25 14:47:22",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "TwitchIO",
"github_project": "TwitchIO",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "aiohttp",
"specs": [
[
">=",
"3.9.1"
],
[
"<",
"4"
]
]
}
],
"lcname": "twitchio"
}
JSON
