wardyns-feditools/README.md

54 lines
1.8 KiB
Markdown

# wardyns-feditools
Collection of simple tools to add functionality to the fediverse
## Installation
All these tools are designed to run in the same directory in order to prevent generating multiple access tokens. Installation is simple, download master branch as zip, extract into a folder of your choice, then, in that directory, run:
pip install -r requirements.txt
**Note:** These programs were written and tested in python 3.8
## Usage
All the programs are created with a built in help command, simply run [script] -h
## fedisearch.py
fedisearch is a tool that allows you to search through a users profile for a specific keyword or phrase.
Limitations:
- Very slow. Takes longer the the older a post is
- Does not currently support regular expressions
## autodeny.py
Used to automatically deny follow requests that do not pass certain tests. Those tests are:
1. The user has more than 1 post (configurable)
2. The user has a pfp other than the default one their instance assigns.
3. The user has text within their bio
It will not deny a follow request if you are following the user
You can also specify instances to block all follow requests from
## highestpost.py
Used to find the highest-rated post for a given account.
Example:
Running `highestpost.py wardyns_feditools@example.com`, the output might look like this:
boost for a cookie
Favorites: 8 Boosts: 23
link: https://example.com/@wardyns_feditools/22190
-------
## notification_sound.py
Used to play a sound when a notification is received.
replace `notification.mp3` to change the notification sound. default is from the mastodon repository
## import_following.py
Used to batch follow users from a .csv file. Created because I had issues with the follow import built into pleroma, however if that feature works fine for you I recommend you use it instead.