Skip to main content

harambot-banner

Harambot

An interactive Yahoo Fantasy sports bot for Discord.

Python License Build Version

Discord

Commands

/ping                           - Gives the latency of harambot.
/RIP                            - Pay respects.
/standings                      - Returns the current standings of the current league.
/roster Team                    - Returns the roster of the given team.
/stats Player                   - Returns the details of the given player.
/trade                          - Create a poll for latest trade for league approval.
/matchups week                  - Returns the matchups for the given week, defaults to the current week.
/waiver days                    - Returns the waiver wire transactions from the previous number of days.
/configure                      - Configure the bot for your guild.
/reports                        - Set what channel transaction reports should be sent to.
/league                         - Set what league the bot should use for commands.

You can find example output of these commands here

Roll your own instance

Prerequisites

In order to properly configure your bot you will need the following:

Visit our wiki for a step by step guide on how to obtain these values.

Generate a key for your local database

Parts of the database are encrypted, which means we need to generate a key. Using the python interactive interpreter, you can generate one by running these three lines inside the interpreter:

from cryptography.fernet import Fernet
fernet_key = Fernet.generate_key()
print(fernet_key.decode())

Your key will appear below.

Run the bot on Render

Deploy to Render

Run the bot locally using pip package

  1. Install the harambot package using pip

     pip install harambot
    
  2. Export the following environment variables

    export DISCORD_TOKEN='[YOUR DISCORD TOKEN]'
    export YAHOO_KEY='[YOUR YAHOO API CLIENT ID]'
    export YAHOO_SECRET='[YOUR YAHOO API CLIENT SECRET]'
    export DATABASE_URL='[YOUR DATABASE URL]' # which can be a pathway to a file, such as 'sqllite:///harambot.db'
    export HARAMBOT_KEY='[YOUR ENCRYPTION KEY]' # A URL-safe base64-encoded 32-byte key
    
  3. Run the bot

     harambot
    

Run the bot locally using docker

  1. Pull the latest image from docker hub

     docker pull dmcp89/harambot
    
  2. Export the following environment variables

    export DISCORD_TOKEN='[YOUR DISCORD TOKEN]'
    export YAHOO_KEY='[YOUR YAHOO API CLIENT ID]'
    export YAHOO_SECRET='[YOUR YAHOO API CLIENT SECRET]'
    export DATABASE_URL='[YOUR DATABASE URL]'
    export HARAMBOT_KEY='[YOUR ENCRYPTION KEY]' # A URL-safe base64-encoded 32-byte key
    
  3. Run the bot

     docker run --name harambot \
     -e DISCORD_TOKEN=$DISCORD_TOKEN \
     -e YAHOO_KEY=$YAHOO_KEY \
     -e YAHOO_SECRET=$YAHOO_SECRET \
     -e DATABASE_URL=$DATABASE_URL \
     -e HARAMBOT_KEY=$HARAMBOT_KEY \
     --rm dmcp89/harambot
    

Setup

Add the bot to your guild

  1. Generate a OAuth url from the discord developer portal using the bot scope and the following permissions:
  • Send Messages
  • Send Messages in Threads
  • Embed Links
  • Attach Files
  • Read Message History
  • Add Reactions
  • Use Slash Commands
  • Manage WebHooks

The permission value should be 277562378304

discord-oauth

  1. Navigate to the generated url in a web browser and authorize the bot for your guild

discord-oauth-url-1 discord-oauth-url-2

Configure your guild

  • Once your bot is added to your guild you can configure it by using the /configure command:

discord-config-commnd

  • Use the Login with Yahoo button to authenticate with Yahoo and get your Yahoo token (this is a one time token)

discord-config-yahoo

  • Use the Configure Guild button to configure your guild for the bot

discord-config-guild

  • You can reconfigure your guild by running the configure command and clicking the Configure Guild button.

discord-config-guild

Metadata

Release files for harambot 0.5.3

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for harambot 0.5.3
File Size Uploaded
harambot-0.5.3.tar.gz 6.3 MB Details

Built distribution (wheel)

Table of built distributions (wheels) for harambot 0.5.3
File Interpreter ABI Platform
harambot-0.5.3-py3-none-any.whl Python 3 none any Details

Total release size: 6.4 MB

Release files / harambot-0.5.3.tar.gz

Download URL harambot-0.5.3.tar.gz
Size 6.3 MB
Tags Source
SHA-256 checksum
How to use checksums
6db32594150f4bbe3b0903cba25946c09896c335ec9b7bb3afab9a5de89f1aef
BLAKE2b-256 checksum
How to use checksums
39585f38fd861c5289a7bf788078669363b54721cfd46f6de5e7b42fb6a0aca6
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/2.1.3 CPython/3.10.12 Linux/7.1.1-76070101-generic

Release files / harambot-0.5.3-py3-none-any.whl

Download URL harambot-0.5.3-py3-none-any.whl
Size 20.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
96ea4f43698ef842b11624a9059ad65e443c4ea77852bb3cc72b0e52947ccd65
BLAKE2b-256 checksum
How to use checksums
dfc983d5af391c285f87875744160e5457e3367bd786a763b5fbf07effea7224
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/2.1.3 CPython/3.10.12 Linux/7.1.1-76070101-generic
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page