add README and LICENSE

This commit is contained in:
Camille Frantz 2025-10-30 17:09:13 +00:00
parent b1a3309cc7
commit c7b2a6bfba
Signed by: fyrfli
SSH key fingerprint: SHA256:oxaZT6PRsoNy2x01TIrx3YE6H6p6gdmG2/Ir05d/bjc
2 changed files with 699 additions and 0 deletions

25
README.md Normal file
View file

@ -0,0 +1,25 @@
# An rudimentary framework for an interactive fediverse bot
This code makes a few assumptions:
- you know how to use a linux command line
- you are familiar with and have worked with the python programming language
- have access to both
There are some relatively hard-coded variables in the code:
- the environment variable names, mainly
For now, this code does the following:
- listens to the user's home feed
- responds to specific prompts:
- will respond to various hellos
- will respond with a quote from a specifically-formatted, internet-accessibe text file
- will print and apprise of events on that timeline
In writing this code, I chose to use generic python modules instead of the well-known Mastodon.py
module - this way we can tweak the code based on our specific quirks if necessary and be less
dependent on Mastodon. As an example: I routinely test my code against GoToSocial as well as
Mastodon and Glicth-Soc.
---
It works! Where we go from here is still yet to be decided.