3.2 KiB
POAP Reddit Bot: Code distribution for POAP events
Table of Contents
Usage
Attendees
todo
Admin via Reddit
Administration of the bot can be performed using commands issued via Reddit private messages (not the newer reddit chat feature). The permission model for this is currently rudimentary. It consists of only a whitelist of reddit usernames controlling access to these commands. This whitelist can only be updated via the API.
To issue a command simply send a private message to the bot user following the formats outlined below. The following link will show you an example: Example Command
The bot is strict about the format of these commands.
Create Event
create_event event_id event_name event_code start_date expiry_date minimum_age minimum_karma
Update Event
update_event event_id event_name event_code start_date expiry_date minimum_age minimum_karma
Create Claims
create_claims event_id code1,code2,code3
... more commands coming
Admin via API
todo
Setup
Clone
First, clone the repository and change into the directory
git clone https://github.com/badinvestment/poap-reddit-bot.git
cd poap-reddit-bot
Configuration
Configure settings.yaml with reddit auth information
reddit:
auth:
username: <reddit_username> # It's recommended to create a dedicated account, but you can use a personal account
password: <reddit_password>
client_id: <app_client_id>
client_secret: <app_client_secret>
user_agent: "POAPbot by /u/Bad_Investment https://github.com/badinvestment/poap-reddit-bot" # Optionally change this, but you don't need to
db:
url: sqlite:///poap.db # Optionally rename sqlite db file (Postgres support coming soon)
poap:
url: https://poap.xyz/claim/ # Optionally change POAP claim link. This link is forced when adding claims via Reddit DMs
Deploy
Both of the below methods will start a webserver on your machine and by default expose the API at localhost:8000
To interact with the API, the OpenAPI (Swagger) interface is available at localhost:8000/docs
ReDoc is also available at localhost:8000/redoc
Docker
To start the app server using docker-compose, run:
docker-compose up
Python
To start the app server directly, run:
pip3 install -r requirements.txt # setup a virtual environment first, if desired
uvicorn poapbot.app:app #optional flags: --host 0.0.0.0 --port 8000