Browse Source

version bump, improve docs

merge-requests/3/head 20170723.3
KemoNine 4 years ago
parent
commit
dd5c1b1487
  1. 17
      README.md
  2. 4
      setup.py

17
README.md

@ -6,6 +6,8 @@ This was designed with the admin in mind and functionality will grow over time.
# Features
- Ability to regularly post a toot + sub toots
- Ability to toot articles that are in an RSS feed
- Ability to auto welcome new users to an instance
- Ability to autorespond to mentions
- Ability to hide toots behind CW text
# Compatibility
@ -62,7 +64,20 @@ Seriously, this is DANGEROUS if your instance has been around for a bit. You may
Note: the welcome cache will be initialized the first time you run the welcome command
You'll probably want to run the 2nd command via the sample systemd unit file at ```configs/example_welcome_bot_service```.
You'll probably want to run the 2nd command via the sample systemd unit file at ```configs/example_welcome_bot.service```.
## Auto Respond Bot
To auto respond to @'s (mentions) take a look at 'configs/example_auto_respond_config.yaml' and do the following
1. Run python ```.\toot_bot.py --config .\configs\example_auto_respond_config.yaml init```
1. Run python ```.\toot_bot.py --config .\configs\example_auto_respond_config.yaml autorespond```
The above will initialize the configuration (including login, you'll be prompted for user/password) then auto respond to any @'s (mentions) for the account linked to the bot. *BE CAREFUL*, the cache will be empty to start and you might spam your instance if there are a large number of existing notifications or existing mentions.
Seriously, this is DANGEROUS if your instance has been around for a bit. You may want to try it in development first and/or create the sqlite database by hand and insert a row into toot_cache AND reminder_cache close to the current toot id and notification id of your instance.
Note: the cache will be initialized the first time you run the autorespond command
You'll probably want to run the 2nd command via the sample systemd unit file at ```configs/example_auto_respond_config.service```.
## TOTP
If you're using a bot with an account that has 2FA / TOTP enabled you can pass the ```--totp``` option to ```init``` and ```login``` to make the init and login functions work correctly. There will be additional steps and you'll be prompted to complete the necessary steps.

4
setup.py

@ -4,8 +4,8 @@ from setuptools import setup
setup(
name='mastodon_bot',
version='0.1.0',
description='An announcement bot for Mastodon instances',
version='0.2.0',
description='Various bots for Mastodon instances (see example configs)',
url='https://gitlab.com/photog.social/mastodon_bot',
author='KemoNine',
author_email='mcrosson_mastobot@kemonine.info',

Loading…
Cancel
Save