ekardnam/mastodon-welcome-bot
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

updating README

Browse source
This commit is contained in:
Dave Walk 2018-09-06 06:38:20 -04:00
parent 347ed4feec
commit 1241da5644
1 changed files with 15 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
README.md
View file

@ -6,14 +6,26 @@ this bot queries the followers of an account and pages through for any have been
last x days (see configuration below). This means that you'll want `ACCOUNT_ID` to be an account
that is auto-followed by all new users.
# Installation
# Deploy to Heroku
[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy?template=https://github.com/indyhall/mastodon-welcome-bot)
]
Hosting the bot on Heroku is probably the easiest (and cheapest, it's free!) way to go. There's only a few steps:
1. Click the button above. Once you're logged in to Heroku, you'll be taken to a window where you can set
the environment variables as detailed below. Then you can create the app.
2. Once the app is created, you'll have to schedule when it should run. Heroku's Scheduler addon is
used for this (don't worry, it's free). On your new app's page, click "Heroku Scheduler" under "Installed Add-ons". In the new window, set "python run.py" as the task to run and configure the schedule for the job.
# Installation/Development
Requires:
* python3
* pip
Eventually this will be setup to as a "Deploy to Heroku" app, but for now:
### Steps
1. `git clone git@github.com:indyhall/mastodon-welcome-bot.git`
2. `pip install -r requirements.txt` (you'll probably want to setup a [virtualenv](https://www.pythonforbeginners.com/basics/how-to-use-python-virtualenv) for this)
@ -21,8 +33,6 @@ Eventually this will be setup to as a "Deploy to Heroku" app, but for now:
4. Fill in the env vars as required in the `.env` file (see definitions below)
5. Run the app with `python run.py`
# Usage
### Environment Variables
The application uses the following environment variables.
@ -32,6 +42,6 @@ The application uses the following environment variables.
| ACCESS_TOKEN | yes | n/a | the access token for the Mastodon account that you want the toots to come from |
| DAYS_SINCE | no | 1 | how many days back of new users you want to go |
| INSTANCE_BASE_URL | yes | n/a | the base url of the Mastodon instance you want to run this for (ex: "https://jawns.club") |
| TOOT_TEMPLATE | yes | n/a | the template of the toot that you want to send out. Jinja2 syntax is used here and you can use any of the `Account` variables |
| TOOT_TEMPLATE | yes | n/a | the template of the toot that you want to send out. [Jinja2](http://jinja.pocoo.org/) syntax is used here and you can use any of the [`Account`](https://github.com/tootsuite/documentation/blob/master/Using-the-API/API.md#account) variables |
| DEBUG | no | false | boolean (either "true" or "false") for debug mode. If true, won't actually send out the toots, will just print the message for each to stdout |
| ACCOUNT_ID | yes | n/a | the account ID that you want to pull followers from |