update README

This commit is contained in:
2025-07-08 10:34:11 -05:00
parent 15217f4789
commit afa96d6078

View File

@ -1,5 +1,5 @@
# fyrfli's ActivityPub bots project # fyrfli's ActivityPub bots project
![](https://fyrfli.dev/fyrfli/bots/actions/workflows/dog_facts.yaml/badge.svg) ![](https://fyrfli.dev/fyrfli/bots/actions/workflows/quip.yaml/badge.svg) ![](https://fyrfli.dev/fyrfli/bots/actions/workflows/quotes.yaml/badge.svg) ![](https://fyrfli.dev/fyrfli/bots/actions/workflows/releases.yaml/badge.svg) ![](https://fyrfli.dev/fyrfli/bots/actions/workflows/dog_facts.yaml/badge.svg) ![](https://fyrfli.dev/fyrfli/bots/actions/workflows/quip.yaml/badge.svg) ![](https://fyrfli.dev/fyrfli/bots/actions/workflows/quotes.yaml/badge.svg) ![](https://fyrfli.dev/fyrfli/bots/actions/workflows/releases.yaml/badge.svg) ![](https://fyrfli.dev/fyrfli/bots/actions/workflows/puppies.yaml/badge.svg)
A collection of simple bots that post to an ActivityPub-compatible account that implements the [Mastodon API](https://docs.joinmastodon.org/client/intro/). (Tested with [Gotosocial](https://gotosocial.org) and Mastodon [Glitch Edition](https://glitch-soc.github.io/docs/)) A collection of simple bots that post to an ActivityPub-compatible account that implements the [Mastodon API](https://docs.joinmastodon.org/client/intro/). (Tested with [Gotosocial](https://gotosocial.org) and Mastodon [Glitch Edition](https://glitch-soc.github.io/docs/))
@ -16,6 +16,7 @@ Current bot list:
- [Quips](https://bots.fyrfli.social/@dayswithoutwhitenonsense) (quip.py) I adopted the code I use for the [white nonsense bot](https://bots.fyrfli.social/@dayswithoutwhitenonsense) to use any provided text file that contains a basic list of sayings. - [Quips](https://bots.fyrfli.social/@dayswithoutwhitenonsense) (quip.py) I adopted the code I use for the [white nonsense bot](https://bots.fyrfli.social/@dayswithoutwhitenonsense) to use any provided text file that contains a basic list of sayings.
- [Quotes](https://bots.fyrfli.social/@quotesbot), my first bot. It reads a simple csv-formatted file of quotes. - [Quotes](https://bots.fyrfli.social/@quotesbot), my first bot. It reads a simple csv-formatted file of quotes.
- Repository Release watch, this one reads a list of feed urls and checks for a new entry in the last 8 hours. I have it running every 8 hours. This one does not post to an ActivityPub compatible account/feed... yet. - Repository Release watch, this one reads a list of feed urls and checks for a new entry in the last 8 hours. I have it running every 8 hours. This one does not post to an ActivityPub compatible account/feed... yet.
- The [PuppyBot](https://bots.fyrfli.social/@puppybot) finally made it over. Initially, I was using the [Mastodon.py](https://github.com/halcy/Mastodon.py) library to post because I couldn't figure out how to make requests upload files. But (a) I didn't want to depend on an external library that may or may not suffer from update lag later on and (b) I wanted to get my hands dirty. So after many months of trial and error and brain fog and forgetfulness and fatigue, I finally figured it out.
# Requirements # Requirements
@ -62,11 +63,18 @@ https://github.com/blah/blah/releases.atom,https://codeberg.org/blah/blah/releas
As of now, it only posts to Pushover and it requires a Pushover user and app. As of now, it only posts to Pushover and it requires a Pushover user and app.
## PuppyBot
This bot requires two extra secrets:
```
- BOTS_PUPPYBOT_TOKEN # Access token to your ActivityPub account
- UNSPLASH_API_KEY # API Token from Unsplash.com issued via the [developer panel](https://unsplash.com/developers).
```
# Still to come: # Still to come:
- My newsfeed bot that reads from a list of rss or atom feeds and posts latest entries. - My newsfeed bot that reads from a list of rss or atom feeds and posts latest entries.
- ~Release tracker bot that watches a provided list of got repositories and posts releases to a selected endpoint~ - ~Release tracker bot that watches a provided list of got repositories and posts releases to a selected endpoint~
- Make the release tracker post to discord again - Make the release tracker post to discord again
- The [puppybot](https://bots.fyrfli.social/@puppybot) [code](https://fyrfli.dev/fyrfli/puppybot) needs to be able to upload media via the requests library before I am willing to include it here. - ~The [puppybot](https://bots.fyrfli.social/@puppybot) [code](https://fyrfli.dev/fyrfli/puppybot) needs to be able to upload media via the requests library before I am willing to include it here.~
# Maybe someday # Maybe someday
- Provide several options for output - e.g. Discord, Telegram, etc. - Provide several options for output - e.g. Discord, Telegram, etc.