Skip to main content

Automate posting and hosting of rounds on /r/picturegame

Project description

Botterino

Botterino allows automation of hosting and posting of /r/picturegame coordinates rounds

When running botterino, if you win a round, your round will automatically be posted. It will reply with 'x' or '+correct' to any comments on your round automatically, with configurable tolerances.


Pre-requisites

  1. All the files you interact with will live in the botterino-config folder which is located:
    1. windows: C:\Users\your username\botterino-config
    2. mac: /Users/<your username/botterino-config
    3. linux: ~/botterino-config These files are created for you the first time you run the bot
  2. You must have Python installed on your computer
    1. If on windows it is best to install python from the microsoft store
  3. Install the bot
    1. open a terminal or command prompt window and type the following command: pip install botterino
  4. You must create a Reddit app and add authentication details in botterino-config/praw.ini; see sample-praw.ini for an example
    1. Give app any name you choose, such as 'botterino'
    2. Choose 'script' as app type
    3. Fill in 'redirect URI' with http://localhost:8080 (This is irrelevant but it's a required field)
    4. Once created, you'll have a 'secret', copy/paste that as client_secret in botterino-config/praw.ini
    5. You'll also have a less obvious client id, in the top left under the app name and the words 'personal use script' - copy/paste that into client_id in praw.ini
  5. Fill out the rest of 'botterino-config/praw.ini' with your Reddit username/password as well as anything you want for user_agent

Usage

  • add round(s) in botterino-config/rounds/rounds.yaml
  • run with python -m botterino

Normal hosting

Rounds are kept in the 'rounds/rounds.yaml' file, see 'sample.yaml' for some examples

Steps

  1. Add round(s) to 'botterino-config/rounds/rounds.yaml'
  2. Open a terminal or command prompt and type python -m botterino
    1. Then all you have to do is win. Until you win, botterino will do nothing
    2. When you win, the top round in rounds.yaml is posted as soon as you are approved to host

Any new rounds added to 'botterino-config/rounds/rounds.yaml' while the app is running will automatically be added to the queue, no need to restart. Once a round is complete, it will be moved to 'botterino-config/rounds/archive.yaml'.

Live rounds

Botterino can be used on a round that is already live

This is useful for cases where

  1. You post manually and decide you would like bot to host
  2. Bot posts for you but crashes during hosting for some reason

Steps

  1. Will use the top round in rounds.yaml
    1. url field should be omitted
  2. Run with python -m botterino.failure

Misc

Update

Update this botterino with pip install --upgrade botterino

Issues

  • Bot does not run, crash message shows 403 error, everything in praw.ini looks correct
    1. try a different user agent

Colors on windows

This botterino uses colorful output. If you see strange output like this on windows Strange windows output then download Windows terminal from the Microsoft store.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

botterino-0.1.3.tar.gz (10.9 kB view details)

Uploaded Source

Built Distribution

botterino-0.1.3-py3-none-any.whl (11.7 kB view details)

Uploaded Python 3

File details

Details for the file botterino-0.1.3.tar.gz.

File metadata

  • Download URL: botterino-0.1.3.tar.gz
  • Upload date:
  • Size: 10.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.5.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.0 CPython/3.9.4

File hashes

Hashes for botterino-0.1.3.tar.gz
Algorithm Hash digest
SHA256 84dc3751f09172cd5644ecf1ad8e0e7a7ab423af65298ddfb37ec1248676b601
MD5 698ecfe960b5e0d7d49d5a2d20653519
BLAKE2b-256 7d73b3030fd9c0bda98e8e0647c81c10dec80aa8d356e90f2d2cd621f83b23b7

See more details on using hashes here.

File details

Details for the file botterino-0.1.3-py3-none-any.whl.

File metadata

  • Download URL: botterino-0.1.3-py3-none-any.whl
  • Upload date:
  • Size: 11.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.5.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.0 CPython/3.9.4

File hashes

Hashes for botterino-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 0f2cba6a79f7cfdffc2f8a4fd9a6e575fca927c75e56a4cf050d343515ae1e49
MD5 0093cbbbc7f84935d5504b4c35804cf2
BLAKE2b-256 b238be848a947da4bc60c8e0062471b55b1ed24e76ac33c1fab7156557eae495

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page