aboutsummaryrefslogtreecommitdiffstats
path: root/bot/cogs/template.py
blob: aa01432c7d960bd1cd8189da1b2910896ac711f9 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
from discord.ext import commands


class Template:

    """
    A template cog that contains examples of commands and command groups.
    """

    def __init__(self, bot):
        self.bot = bot

    @commands.command(name='repo', aliases=['repository', 'project'], brief='A link to the repository of this bot.')
    async def repository(self, ctx):
        """
        A command to send the hacktoberbot github project
        """
        await ctx.send('https://github.com/discord-python/hacktoberbot')

    @commands.group(name='git', invoke_without_command=True, brief="A link to resources for learning Git")
    async def github(self, ctx):
        """
        A command group with the name git. You can now create sub-commands such as git commit.
        """

        await ctx.send('Resources to learn **Git**: https://try.github.io/.')

    @github.command()
    async def commit(self, ctx):
        """
        A command that belongs to the git command group. Invoked using git commit.
        """

        await ctx.send('`git commit -m "First commit"` commits tracked changes.')


# Required in order to load the cog, use the class name in the add_cog function.
def setup(bot):
    bot.add_cog(Template(bot))