commit 860843dc7a786f056713f203cbe4e61f38a579d8 Author: Terry Hearst Date: Mon Sep 12 19:02:45 2022 -0400 Initial commit diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..68bc17f --- /dev/null +++ b/.gitignore @@ -0,0 +1,160 @@ +# Byte-compiled / optimized / DLL files +__pycache__/ +*.py[cod] +*$py.class + +# C extensions +*.so + +# Distribution / packaging +.Python +build/ +develop-eggs/ +dist/ +downloads/ +eggs/ +.eggs/ +lib/ +lib64/ +parts/ +sdist/ +var/ +wheels/ +share/python-wheels/ +*.egg-info/ +.installed.cfg +*.egg +MANIFEST + +# PyInstaller +# Usually these files are written by a python script from a template +# before PyInstaller builds the exe, so as to inject date/other infos into it. +*.manifest +*.spec + +# Installer logs +pip-log.txt +pip-delete-this-directory.txt + +# Unit test / coverage reports +htmlcov/ +.tox/ +.nox/ +.coverage +.coverage.* +.cache +nosetests.xml +coverage.xml +*.cover +*.py,cover +.hypothesis/ +.pytest_cache/ +cover/ + +# Translations +*.mo +*.pot + +# Django stuff: +*.log +local_settings.py +db.sqlite3 +db.sqlite3-journal + +# Flask stuff: +instance/ +.webassets-cache + +# Scrapy stuff: +.scrapy + +# Sphinx documentation +docs/_build/ + +# PyBuilder +.pybuilder/ +target/ + +# Jupyter Notebook +.ipynb_checkpoints + +# IPython +profile_default/ +ipython_config.py + +# pyenv +# For a library or package, you might want to ignore these files since the code is +# intended to run in multiple environments; otherwise, check them in: +# .python-version + +# pipenv +# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. +# However, in case of collaboration, if having platform-specific dependencies or dependencies +# having no cross-platform support, pipenv may install dependencies that don't work, or not +# install all needed dependencies. +#Pipfile.lock + +# poetry +# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control. +# This is especially recommended for binary packages to ensure reproducibility, and is more +# commonly ignored for libraries. +# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control +#poetry.lock + +# pdm +# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control. +#pdm.lock +# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it +# in version control. +# https://pdm.fming.dev/#use-with-ide +.pdm.toml + +# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm +__pypackages__/ + +# Celery stuff +celerybeat-schedule +celerybeat.pid + +# SageMath parsed files +*.sage.py + +# Environments +.env +.venv +env/ +venv/ +ENV/ +env.bak/ +venv.bak/ + +# Spyder project settings +.spyderproject +.spyproject + +# Rope project settings +.ropeproject + +# mkdocs documentation +/site + +# mypy +.mypy_cache/ +.dmypy.json +dmypy.json + +# Pyre type checker +.pyre/ + +# pytype static type analyzer +.pytype/ + +# Cython debug symbols +cython_debug/ + +# PyCharm +# JetBrains specific template is maintained in a separate JetBrains.gitignore that can +# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore +# and can be added to the global gitignore or merged into this file. For a more nuclear +# option (not recommended) you can uncomment the following to ignore the entire idea folder. +#.idea/ diff --git a/README.md b/README.md new file mode 100644 index 0000000..a3099a0 --- /dev/null +++ b/README.md @@ -0,0 +1,27 @@ +# thearstbot - thearst3rd's Twitch Bot + +I thought it'd be fun to make a twitch bot, so here it is! It doesn't do much, I mostly just followed [tutorials online](https://dev.to/ninjabunny9000/let-s-make-a-twitch-bot-with-python-2nd8). It may or may not be active on [my twitch channel](https://twitch.tv/thearst3rd). + +## Run instructions + +Install [python3](https://www.python.org/downloads/), then install the requirements: + +``` +pip3 install -r requirements.txt +``` + +Create a `.env` file with the following details: + +``` +TMI_TOKEN=oauth: +CLIENT_ID= +CHANNEL= +``` + +Then, run the bot: + +``` +python3 bot.py +``` + +Ask me for help if none of this makes sense lol diff --git a/bot.py b/bot.py new file mode 100644 index 0000000..c4c5737 --- /dev/null +++ b/bot.py @@ -0,0 +1,30 @@ +# Basic twitch bot + +import os +from twitchio.ext import commands +from dotenv import load_dotenv + + +class Bot(commands.Bot): + def __init__(self): + super().__init__(token = os.environ["TMI_TOKEN"], prefix="!", initial_channels=[os.environ["CHANNEL"]]) + + async def event_ready(self): + print(f"Logged in as | {self.nick}") + print(f"User id is | {self.user_id}") + + @commands.command() + async def hello(self, ctx: commands.Context): + # Basic hello world command, executed with "!hello". Reply hello to whoever made the command + await ctx.send(f"Hello {ctx.author.name}!") + + +def main(): + load_dotenv() + bot = Bot() + bot.run() + # bot.run() is blocking and will stop execution of any below code here until stopped or closed. + + +if __name__ == "__main__": + main() diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..38ecb64 --- /dev/null +++ b/requirements.txt @@ -0,0 +1,2 @@ +twitchio==2.4.0 +python-dotenv==0.21.0