.. meta::
   :title: TwitchIO Documentation
   :description: Documentation for TwitchIO, the asynchronous Python wrapper for Twitch.tv.
   :language: en-US
   :keywords: twitchio, twitch, python api
   :copyright: TwitchIO. 2017 - Present


.. raw:: html

   <img src="_static/logo_light.png" class="featuring-logo only-light">
   <img src="_static/logo_dark.png" class="featuring-logo only-dark">
   <hr class="featuring-hr">

   <p class="index-featuring">

      <b>A fully asynchronous <a href="https://www.python.org/">Python</a> IRC, API, EventSub and PubSub library for Twitch.</b>

      <h4>Featuring:</h4>
      <ul class="index-featuring-list">
         <li>Full asynchronous design.</li>
         <li>Covers 100% of the Twitch API.</li>
         <li>IRC Commands extension for creating powerful chat bots.</li>
         <li>EventSub and PubSub support.</li>
         <li>Helper extensions for Music/Sounds and Background Tasks.</li>
         <li>Object orientated design with stateful objects.</li>
      </ul>
   </p>

   <h3 class="index-section-header">Getting Started</h3>
   <hr class="featuring-hr">
   For help with getting started with the library for the first time.

   <ul class="index-featuring-list">
      <li><b>For help with installing visit:</b> <a href="installing.html" class="reference internal">Installing</a>
      <li><b>Your first steps with the library:</b> <a href="quickstart.html" class="reference internal">Quickstart</a>
      <li><b>Frequently asked questions:</b> <a href="faq.html" class="reference internal">FAQ</a>
   </ul>

   <h3 class="index-section-header">API Reference</h3>
   <hr class="featuring-hr">
   The API References of TwitchIO.

   <div class="index-apis-wrapper">
      <div class="index-apis-section">
         <b>TwitchIO Client Reference:</b>
         <ul class="index-featuring-list">
            <li><a href="twitchio.html" class="reference internal">Client Reference</a>
            <li><a href="reference.html" class="reference internal">Dataclass Reference</a>
         </ul>
      </div>

      <div class="index-apis-section">
         <b>TwitchIO Extension API's:</b>
         <ul class="index-featuring-list">
            <li><a href="exts/commands.html" class="reference internal">Commands EXT</a>
            <li><a href="exts/pubsub.html" class="reference internal">PubSub EXT</a>
            <li><a href="exts/eventsub.html" class="reference internal">EventSub EXT</a>
            <li><a href="exts/routines.html" class="reference internal">Routines EXT</a>
            <li><a href="exts/sounds.html" class="reference internal">Sounds EXT</a>
         </ul>
      </div>
   </div>

   <h3 class="index-section-header">Getting Help</h3>
   <hr class="featuring-hr">
   Consider joining the Official Discord server for a fast response to help.<br>
   <a href="https://discord.gg/RAKc3HF"><img src="https://discordapp.com/api/guilds/490948346773635102/widget.png?style=banner2"></a><br><br>

   <b>For issues and contributing with the library, visit:</b> <a href="https://github.com/TwitchIO/TwitchIO">GitHub</a>


.. rst-class:: index-display-none
.. toctree::
   :maxdepth: 1
   :caption: Getting Started

   installing
   quickstart
   faq

.. rst-class:: index-display-none
.. toctree::
   :maxdepth: 1
   :caption: API Reference

   twitchio
   reference

.. rst-class:: index-display-none
.. toctree::
   :maxdepth: 1
   :caption: Extensions API's:

   exts/commands
   exts/pubsub
   exts/eventsub
   exts/routines
   exts/sounds


.. raw:: html

   <h3 class="index-section-header">Changelog</h3>
   <hr class="featuring-hr">
   Keep upto date with the changelog.<br><br>

.. rst-class:: index-changelog
.. toctree::
   :maxdepth: 2
   :caption: Changelog

   changelog


.. raw:: html

   <h3 class="index-section-header">Table of Contents</h3>
   <hr class="featuring-hr">

* :ref:`genindex`
* :ref:`search`