cleantoots/README.md

74 lines
1.9 KiB
Markdown
Raw Normal View History

2019-12-26 18:41:37 +01:00
# Cleantoots
2019-12-26 19:12:54 +01:00
The idea of cleantoots is highly inspired by [magnusnissel/cleantweets](https://github.com/magnusnissel/cleantweets).
2019-12-26 18:41:37 +01:00
## Initial config
Only once
```bash
2019-12-27 19:16:26 +01:00
python -m pip install cleantoots
cleantoots setup-config # See the following section for config options
cleantoots login
```
## Config options
```ini
# Any key in this section will serve as a default for other sections
[DEFAULT]
# Toots that have at least this number of boosts won't be deleted.
boost_limit = 5
# Toots that have at least this number of favorites won't be deleted.
favorite_limit = 5
# Toots that are more recent than this number of days won't be deleted.
days_count = 30
# The timezone to use for dates comparisons.
timezone = Europe/Paris
# Each section represents an account.
[Fosstodon]
# Your Mastodon server URL.
api_base_url = https://fosstodon.org
# These files are used to store app information obtained when running `login`.
# The files must be different between accounts. Two different files are required per account.
app_secret_file = fosstodon_app.secret
user_secret_file = fosstodon_user.secret
# IDs of toots you want to protect (never delete).
# You can find the toot ID in the URL when viewing a toot.
protected_toots = 103362008817616000
103361883565013391
103363106195441418
# Another account
[Mastodon.social]
api_base_url = https://mastodon.social
app_secret_file = mastodonsocial_app.secret
user_secret_file = mastodonsocial_user.secret
# Overriding some defaults
boost_limit = 10
favorite_limit = 30
days_count = 7
2019-12-26 18:41:37 +01:00
```
## Run
2019-12-27 19:16:26 +01:00
See `cleantoots config` for the current config.
2019-12-26 18:41:37 +01:00
```bash
2019-12-27 19:16:26 +01:00
cleantoots clean # Defaults to a dry run. Does NOT delete.
cleantoots clean --delete # Delete without prompt.
2019-12-26 18:41:37 +01:00
```
2019-12-27 19:51:34 +01:00
## Tested environments
Cleantoots has been only tested on:
* macOS Catalina with Python 3.8.0.
If you use it in an other environment, please tell us so we can update this list.