' % node["python-class"])
+def visit_attributetable_node(self: DPYHTML5Translator, node: attributetable) -> None:
+ class_ = node["python-class"]
+ self.body.append(f'
")
-def depart_attributetabletitle_node(self, node):
+def depart_attributetabletitle_node(self: DPYHTML5Translator, node: attributetabletitle) -> None:
self.body.append("")
-def depart_attributetablebadge_node(self, node):
+def depart_attributetablebadge_node(self: DPYHTML5Translator, node: attributetablebadge) -> None:
self.body.append("")
-def depart_attributetable_item_node(self, node):
+def depart_attributetable_item_node(self: DPYHTML5Translator, node: attributetable_item) -> None:
self.body.append("")
@@ -86,10 +96,13 @@ class PyAttributeTable(SphinxDirective):
required_arguments = 1
optional_arguments = 0
final_argument_whitespace = False
- option_spec = {}
+ option_spec: OptionSpec = {}
- def parse_name(self, content):
- path, name = _name_parser_regex.match(content).groups()
+ def parse_name(self, content: str) -> tuple[str, str]:
+ match = _name_parser_regex.match(content)
+ if match is None:
+ raise RuntimeError(f"content {content} somehow doesn't match regex in {self.env.docname}.")
+ path, name = match.groups()
if path:
modulename = path.rstrip(".")
else:
@@ -97,12 +110,13 @@ def parse_name(self, content):
if not modulename:
modulename = self.env.ref_context.get("py:module")
if modulename is None:
- raise RuntimeError("modulename somehow None for %s in %s." % (content, self.env.docname))
+ raise RuntimeError(f"modulename somehow None for {content} in {self.env.docname}.")
return modulename, name
- def run(self):
+ def run(self) -> list[attributetableplaceholder]:
"""If you're curious on the HTML this is meant to generate:
+
')
-def visit_attributetablecolumn_node(self, node):
+def visit_attributetablecolumn_node(self: DPYHTML5Translator, node: attributetablecolumn) -> None:
self.body.append(self.starttag(node, "div", CLASS="py-attribute-table-column"))
-def visit_attributetabletitle_node(self, node):
+def visit_attributetabletitle_node(self: DPYHTML5Translator, node: attributetabletitle) -> None:
self.body.append(self.starttag(node, "span"))
-def visit_attributetablebadge_node(self, node):
+def visit_attributetablebadge_node(self: DPYHTML5Translator, node: attributetablebadge) -> None:
attributes = {
"class": "py-attribute-table-badge",
"title": node["badge-type"],
@@ -54,27 +64,27 @@ def visit_attributetablebadge_node(self, node):
self.body.append(self.starttag(node, "span", **attributes))
-def visit_attributetable_item_node(self, node):
+def visit_attributetable_item_node(self: DPYHTML5Translator, node: attributetable_item) -> None:
self.body.append(self.starttag(node, "li", CLASS="py-attribute-table-entry"))
-def depart_attributetable_node(self, node):
+def depart_attributetable_node(self: DPYHTML5Translator, node: attributetable) -> None:
self.body.append("
")
-def depart_attributetablecolumn_node(self, node):
+def depart_attributetablecolumn_node(self: DPYHTML5Translator, node: attributetablecolumn) -> None:
self.body.append("
_('Attributes')
@@ -122,6 +136,7 @@ def run(self):
+ + +To use certain optional features of TwitchIO you will have to install the required packages needed to run them. +The following commands can be used to install TwitchIO with optional features: + + +**To use the StarletteAdapter**: + +.. code:: shell + + pip install -U twitchio[starlette] --pre + + +**For development purposes**: + +.. code:: shell + + pip install -U twitchio[dev] --pre + + +**For documentation purposes**: + +.. code:: shell + + pip install -U twitchio[docs] --pre + + +Custom Index +============ + +Using TwitchIO with ``Python >= 3.14`` may require the use of a custom pip index. +The index allows pip to fetch pre-built wheels for some dependencies that may require build-tools for C/C++ due to not having released their own wheels for recent versions of Python. + +Usually with time, dependencies will eventually release wheels for new Python releases. +For convenience we provide an index thanks to `Abstract Umbra
+
+
+
+
+**Added:**
+
+- :class:`twitchio.HTTPAsyncIterator`
+
+Events
+======
+
+Events in version 3 have changed internally, however user facing should be fairly similar. One main difference to note
+is that all events accept exactly one argument, a payload containing relevant event data, with the exception of
+:func:`twitchio.event_ready` which accepts exactly ``0`` arguments, and some command events which accept
+:class:`twitchio.ext.commands.Context` only.
+
+For a list of events and their relevant payloads see the :ref:`Event Reference
+
+ await
+ .endpoint(...)
+ ->
+ list[T]
+ async for item in .endpoint(...): + +
+ + async for item in .endpoint(...): + +
- 
- - -
- - A fully asynchronous Python IRC, API, EventSub and PubSub library for Twitch. - -
Featuring:
--
-
- Full asynchronous design. -
- Covers 100% of the Twitch API. -
- IRC Commands extension for creating powerful chat bots. -
- EventSub and PubSub support. -
- Helper extensions for Music/Sounds and Background Tasks. -
- Object orientated design with stateful objects. -
Getting Started
-- For help with getting started with the library for the first time. - -
-
-
- For help with installing visit: Installing -
- Your first steps with the library: Quickstart -
- Frequently asked questions: FAQ -
API Reference
-- The API References of TwitchIO. - -
-
-
-
- TwitchIO Client Reference:
-
-
-
-
- TwitchIO Extension API's:
-
- -
-
- Commands EXT -
- PubSub EXT -
- EventSub EXT -
- Routines EXT -
- Sounds EXT -
Getting Help
-- Consider joining the Official Discord server for a fast response to help.
-
- - For issues and contributing with the library, visit: GitHub - - -.. rst-class:: index-display-none -.. toctree:: - :maxdepth: 1 - :caption: Getting Started +TwitchIO +######### - installing - quickstart - faq +.. warning:: -.. rst-class:: index-display-none -.. toctree:: - :maxdepth: 1 - :caption: API Reference + This is a beta release. Please take care using this release in production ready applications. + + +TwitchIO is a powerful, asynchronous Python library for `twitch.tv
Changelog
-- Keep upto date with the changelog.
+ references/client + references/events + references/user + references/eventsub_subscriptions + references/web + references/exceptions -.. rst-class:: index-changelog .. toctree:: - :maxdepth: 2 - :caption: Changelog + :maxdepth: 1 + :caption: Extension References - changelog + exts/commands/index + exts/routines/index + exts/sounds/index +.. toctree:: + :maxdepth: 1 + :caption: Models -.. raw:: html + references/eventsub_models + references/helix_models -
Table of Contents
-+.. toctree:: + :maxdepth: 1 + :caption: Utils -* :ref:`genindex` -* :ref:`search` + references/utils diff --git a/docs/installing.rst b/docs/installing.rst deleted file mode 100644 index a307ab96..00000000 --- a/docs/installing.rst +++ /dev/null @@ -1,79 +0,0 @@ -:orphan: - -Installing -============ -TwitchIO 2 requires Python 3.7+. -You can download the latest version of Python `here