Skip to content
This repository has been archived by the owner on Jun 24, 2024. It is now read-only.

Installation

Makoto edited this page Aug 9, 2020 · 1 revision

Downloading SauceBot

The first thing you need to do before setting up your own instance of Twitter SauceBot is to download it, naturally!

It's recommended you download the latest stable release from our releases page here:

https://github.com/FujiMakoto/twitter-saucenao/releases/

Simply download and extract the source code wherever you'd like the bot to run.

Alternatively, you can pull the source code from the master branch directly. However, be aware that this may be unstable and will likely contain undocumented changes, so use caution if you decide to go this route.

Setting up a virtual environment

After you have downloaded and extracted SauceBot somewhere, open up a terminal in the twitter-saucebot directory.

It's now highly recommended you set up a virtual environment to run the bot in.

If you don't know how to set up and activate virtual environments, please refer to the Python documentation first:

https://docs.python.org/3/library/venv.html#creating-virtual-environments

Installing dependencies

Make sure you are still in the twitter-saucenao directory and run the following command to install the bots dependencies:

pip install -r requirements.txt

Configuring the bot

For information on configuring the bot, please refer to the Configuration page.

Starting the bot

Once you have everything downloaded, configured, and have all the necessary dependencies installed, you can start the bot by executing the start.py script:

python3 start.py

That's it!

Clone this wiki locally