gaugendre/cleantoots
1
0
Fork 0
Code Issues 1 Pull requests Releases Activity

Update documentation

Browse source
This commit is contained in:
Gabriel Augendre 2019-12-27 19:16:26 +01:00
parent 6d9a168f7a
commit 551b78f7e8
No known key found for this signature in database
GPG key ID: 1E693F4CE4AEE7B4
2 changed files with 53 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

58
README.md
View file

@ -6,16 +6,62 @@ The idea of cleantoots is highly inspired by [magnusnissel/cleantweets](https://
Only once Only once
```bash ```bash
pipenv install python -m pip install cleantoots
pipenv run python main.py create-app cleantoots setup-config # See the following section for config options
pipenv run python main.py get-credentials 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
``` ```
## Run ## Run
See `config.py` for options. See `cleantoots config` for the current config.
```bash ```bash
pipenv run python main.py clean-toots # Defaults to a dry run. Does NOT delete. cleantoots clean # Defaults to a dry run. Does NOT delete.
pipenv run python main.py clean-toots --delete # Delete without prompt. cleantoots clean --delete # Delete without prompt.
``` ```

2
pyproject.toml
View file

@ -1,6 +1,6 @@
[tool.poetry] [tool.poetry]
name = "cleantoots" name = "cleantoots"
version = "0.1.4" version = "0.1.5"
description = "Cleanup your toot history." description = "Cleanup your toot history."
license = "GPL-3.0-or-later" license = "GPL-3.0-or-later"
authors = ["Gabriel Augendre <gabriel@augendre.info>"] authors = ["Gabriel Augendre <gabriel@augendre.info>"]