subalterngames / tanakhbot

Tanakhbot

Tanakhbot is a Discord bot that posts a random Tanakh verse once per day, providing a Koren translation and various JPS translations (depending on what's available). The text was scraped from Sefaria.

For a bot just like this one but for Mishnah, go here.

Covenant

This software uses the MIT license, which you can read here.

This software was originally made for The Torah Studio in order to enable the study of the Queer Tanakh. Alternative use cases, such as the study of the non-queer Tanakh, are theoretically possible but not actively supported by the developers. Usage of this software to suppress the study Queer Tanakh is prohibited.

The user of this software may not be an individual or entity, or a representative, agent, affiliate, successor, attorney, or assign of an individual or entity, identified by the Boycott, Divestment, Sanctions ("BDS") movement on its website (https://bdsmovement.net/ and https://bdsmovement.net/get-involved/what-to-boycott) as a target for boycott. Source: The Hippocratic License

Requirements

• A remote server
• On your computer, git and Python 3.6 or newer
• On the server, Python 3.6 or newer
• Admin privileges on the target Discord server

Setup

1. Discord

1. Create a Discord bot.
2. Get the ID of the channel you want the bot to post to.
3. Get the OAuth2 client ID of the bot (you'll need this in order to add it to the channel).
4. Add the bot to the channel. (Replace the client ID with your bot's client ID)

2. Your remote server

1. Get Python running on your server. How to do this will vary depending on the webhost.
2. Make sure you can ftp and ssh into the server.

3. Your local computer

1. Clone this repo. The rest of this documentation assumes that you've cloned the repo to ~/tanakhbot where ~ is your home directory.
2. Create a file named secrets.txt in the same directory as this file, formatted like this:

ssh_username=USERNAME
ssh_password=PASSWORD
ftp_username=USERNAME
ftp_password=PASSWORD
ftp=ftp.URL
hostname=URL
ssh_cwd=URL/PATH

• USERNAME and PASSWORD are your login credentials.
• URL is the server url, for example my_server.com
• URL/PATH is the path to the directory where the Discord bot should be uploaded. The .htaccess file will be uploaded here and everything else will be uploaded to URL/PATH/public/.

3. Create a file named bot_secrets.txt in the same directory as this file, formatted like this:

token=BOT_TOKEN
channel=CHANNEL_ID

In a terminal:

1. cd ~/mishnabot
2. python3 ftp.py This will upload mishnabot to your server. On Windows, run py -3 ftp.py instead.
3. ssh USERNAME@SERVER
4. cd path/to/tanakhbot
5. python3 -m pip install -e .
6. timedatectl to get the timezone of your server.
7. crontab -e
8. Add this line to the crontab file:

0 15 * * * python3 ~/PATH/run.py > ~/path/to/log.txt

Replace 15 (3:00 PM) with the correct time.

Replace PATH with the actual path on the server, for example ~/my_server.com/public/run.py

9. To exit nano, ctrl+x and y and enter
10. exit