A python package for creating Twitch Bots
Project description
J-Core
This framework is a simple wrapper for creating Twitch bots using Python. The Jarvis chatbot for twitch and discord has been built using the J-Core framework for it's Twitch components.
A full set of documentation is still being developed, however, a getting started guide is outlined below.
Getting started
Installation
To install the J-Core framework using pip:
pip install jcore
To install using this repository:
- clone the directory using
git clone
- navigate into the directory and use
pip install
Creating a Simple Bot
To create a simple bot, start by creating a new python file called simple_bot.py
and copy the code below into the file.
import asyncio
import jcore
from jcore.message import CommandMessage
class SimpleBot(jcore.Client):
async def on_command(self, message: CommandMessage):
if message.KEYWORD == "hi":
await message.send(f"hello {message.display_name}")
if __name__ == "__main__":
client = SimpleBot()
loop = asyncio.get_event_loop()
loop.run_until_complete(client.run())
loop.close()
Next, create a file called config.json
and copy the following snippet into the file.
{
"nick": "<nick>",
"token": "<token>",
"channels": [
"<channel>",
"<channel>",
"<channel>"
]
}
Replace:
<nick>
with the username of your bot account.<token>
with the oauth token for your bot. Refer to the Twitch Documentation - Getting Tokens for more information about generating an oauth token.<channel>
with the channels you want to connect to.
Once all the values have been set, you can start your bot using:
python3 simple_bot.py
or
py simple_bot.py
Adding Logging
If you need to view the logging output of from the framework for your bot, you can configure logging by adding the logging import to the top of your file:
import asyncio
import jcore
from jcore.message import CommandMessage
import logging
Then update the main section of your code to the following:
if __name__ == "__main__":
logging.basicConfig(level=logging.INFO, format='%(asctime)s [%(levelname)s] %(name)s: %(message)s')
client = SimpleBot()
loop = asyncio.get_event_loop()
loop.run_until_complete(client.run())
loop.close()
For more information on using the logging library, refer to the python logging documentation.
Examples
These examples above and more can be found in the examples folder.
Support
If you require any further support, please join the discord and seek help from the commuity.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for jcore-0.2.0.533-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 45aca5bc2b3db07dd98df23e68d298f0a82c78b9d90d71fdbf13b705faa0cfd6 |
|
MD5 | 5bc5bfad7ac321b69a01a45bd65f4556 |
|
BLAKE2b-256 | 781a6ea76da9b827bfa97713181589e8ddb4674cc1a3e16b7aa0e06410934564 |