Update docs and add examples

Update typos in docs
Add examples folder and exmaples

Author: chillymosh

docs/exts/eventsub.rst

@@ -39,6 +39,52 @@ A Quick Example
     bot.loop.create_task(bot.start())
     bot.loop.run_forever()
 
+
+Running Eventsub Inside a Commands Bot
+---------------------------------------
+
+.. code-block:: python3
+
+    import twitchio
+    from twitchio.ext import commands, eventsub
+
+    esbot = commands.Bot.from_client_credentials(client_id='...',
+                                             client_secret='...')
+    esclient = eventsub.EventSubClient(esbot,
+                                       webhook_secret='...',
+                                       callback_route='https://your-url.here/callback')
+
+
+    class Bot(commands.Bot):
+
+        def __init__(self):
+            super().__init__(token='...', prefix='!', initial_channels=['channel'])
+
+        async def __ainit__(self) -> None:
+            self.loop.create_task(esclient.listen(port=4000))
+
+            try:
+                await esclient.subscribe_channel_follows(broadcaster=channel_ID)
+            except twitchio.HTTPException:
+                pass
+
+        async def event_ready(self):
+            print('Bot is ready!')
+
+
+    bot = Bot()
+    bot.loop.run_until_complete(bot.__ainit__())
+
+
+    @esbot.event()
+    async def event_eventsub_notification_follow(payload: eventsub.ChannelFollowData) -> None:
+        print('Received event!')
+        channel = bot.get_channel('channel')
+        await channel.send(f'{payload.user.name} followed woohoo!')
+
+    bot.run()
+
+
 Event Reference
 ----------------
 This is a list of events dispatched by the eventsub ext.

docs/exts/routines.rst

@@ -42,14 +42,14 @@ routine.
 
     @routines.routine(hours=1)
     async def hello():
-        print('Hello World!)
+        print('Hello World!')
 
     @hello.before_routine
     async def hello_before():
         print('I am run first!')
 
 
-    @hello.start()
+    hello.start()
 
 
 **Routine with an error handler:**
@@ -86,7 +86,7 @@ It will then be ran every 24 hours after the initial date, until stopped.
 
 If the **date** has already passed, the routine will run at the next specified time.
 For example: If today was the **2nd, June 2021 8:30am** and your datetime was scheduled to run on the
-**1st, June 2021 at 9:30am**, you routine will first run on **2nd, June 2021 at 9:30am**.
+**1st, June 2021 at 9:30am**, your routine will first run on **2nd, June 2021 at 9:30am**.
 
 In simpler terms, datetimes in the past only care about the time, not the date. This can be useful when scheduling
 routines that don't need to be started on a specific date.

docs/exts/sounds.rst

@@ -9,7 +9,7 @@ Sounds Ext
 Sounds is an extension to easily play sounds on your local machine plugged directly into your bot.
 Sounds is currently a Beta release, and as such should be treated so.
 
-Currently sounds supports local files, and YouTube searches. See below for more details.
+Currently sounds supports local files and YouTube searches. See below for more details.
 
 Sounds requires a few extra steps to get started, below is a short guide on how to get started with sounds:
 

examples/basic_bot.py

@@ -0,0 +1,44 @@
+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...
+        # prefix can be a callable, which returns a list of strings or a string...
+        # initial_channels can also be a callable which returns a list of strings...
+        super().__init__(token='ACCESS_TOKEN', prefix='?', initial_channels=['...'])
+
+    async def event_ready(self):
+        # Notify us when everything is ready!
+        # 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}')
+
+    async def event_message(self, message):
+        # Messages with echo set to True are messages sent by the bot...
+        # For now we just want to ignore them...
+        if message.echo:
+            return
+
+        # Print the contents of our message to console...
+        print(message.content)
+
+        # Since we have commands and are overriding the default `event_message`
+        # We must let the bot know we want to handle and invoke our commands...
+        await self.handle_commands(message)
+
+    @commands.command()
+    async def hello(self, ctx: commands.Context):
+        # Here we have a command hello, we can invoke our command with our prefix and command name
+        # e.g ?hello
+        # We can also give our commands aliases (different names) to invoke with.
+
+        # Send a hello back!
+        # Sending a reply back to the channel is easy... Below is an example.
+        await ctx.send(f'Hello {ctx.author.name}!')
+
+
+bot = Bot()
+bot.run()
+# bot.run() is blocking and will stop execution of any below code here until stopped or closed.

examples/basic_routine.py

@@ -0,0 +1,9 @@
+from twitchio.ext import routines
+
+# This routine will run every 5 seconds for 5 iterations.
+@routines.routine(seconds=5.0, iterations=5)
+async def hello(arg: str):
+    print(f'Hello {arg}!')
+
+
+hello.start('World')

examples/eventsub.py

@@ -0,0 +1,34 @@
+import twitchio
+from twitchio.ext import commands, eventsub
+
+esbot = commands.Bot.from_client_credentials(client_id="...", client_secret="...")
+esclient = eventsub.EventSubClient(esbot, webhook_secret="...", callback_route="https://your-url.here/callback")
+
+
+class Bot(commands.Bot):
+    def __init__(self):
+        super().__init__(token="...", prefix="!", initial_channels=["channel"])
+
+    async def __ainit__(self) -> None:
+        self.loop.create_task(esclient.listen(port=4000))
+        try:
+            await esclient.subscribe_channel_follows(broadcaster=channel_ID)
+        except twitchio.HTTPException:
+            pass
+
+    async def event_ready(self):
+        print("Bot is ready!")
+
+
+bot = Bot()
+bot.loop.run_until_complete(bot.__ainit__())
+
+
+@esbot.event()
+async def event_eventsub_notification_follow(payload: eventsub.ChannelFollowData) -> None:
+    print("Received event!")
+    channel = bot.get_channel("channel")
+    await channel.send(f"{payload.user.name} followed woohoo!")
+
+
+bot.run()

twitchio/client.py

@@ -432,7 +432,9 @@ async def fetch_clips(self, ids: List[str]):
         return [models.Clip(self._http, d) for d in data]
 
     async def fetch_channel(self, broadcaster: str):
-        """Retrieve channel information from the API.
+        """|coro|
+
+        Retrieve channel information from the API.
 
         Parameters
         -----------