Mastodon
/
ephemetoot-eliminare-vecchi-messaggi
mirror of https://github.com/hughrun/ephemetoot
1
0
Fork 0
Code Issues Releases Wiki Activity

update docs

This commit is contained in:
Hugh Rundle 2023-06-18 19:22:15 +10:00
parent c3f366bf3f
commit 52f7fd302d
2 changed files with 5 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
README.md
View File

@ -1,8 +1,9 @@
# 🥳 ==> 🧼 ==> 😇 # 🥳 ==> 🧼 ==> 😇
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](https://makeapullrequest.com)
**ephemetoot** is a Python command line tool for deleting old toots. **ephemetoot** is a Python command line tool for deleting old toots.
As Mastodon now has similar functionality built in, `ephemetoot` is now in maintenance mode - no new features will be added, only security updates.
## Quickstart ## Quickstart
You should have Python3 and pip installed, and an app access token on hand. More detail information is available in [the docs](https://ephemetoot.hugh.run) You should have Python3 and pip installed, and an app access token on hand. More detail information is available in [the docs](https://ephemetoot.hugh.run)
@ -48,7 +49,7 @@ You can use `ephemetoot` to delete [Mastodon](https://github.com/tootsuite/masto
## Contributing ## Contributing
ephemetoot is tested using `pytest`. ephemetoot is tested using `pytest`.
For all bugs, suggestions, pull requests or other contributions, please check the [contributing guide](./docs/contributing.md). For bugs or other contributions, please check the [contributing guide](./docs/contributing.md).
## License ## License
This project and all contributions are [licensed](./LICENSE) under the GPL 3.0 or future version This project and all contributions are [licensed](./LICENSE) under the GPL 3.0 or future version

1
docs/install.md
View File

@ -62,6 +62,7 @@ Calling `--init` will save your configuration file as `config.yaml` in the curre
| base_url | **required** - The base url of your Mastodon server, without the 'https://'. e.g. `ausglam.space`| | base_url | **required** - The base url of your Mastodon server, without the 'https://'. e.g. `ausglam.space`|
| days_to_keep | Number of days to keep toots e.g. `30`. If no value is provided the default number is 365 | | days_to_keep | Number of days to keep toots e.g. `30`. If no value is provided the default number is 365 |
| keep_pinned | Either `true` or `false` - if `true`, any pinned toots will be kept regardless of age | | keep_pinned | Either `true` or `false` - if `true`, any pinned toots will be kept regardless of age |
| boosts_only | Either `true` or `false`. |
| toots_to_keep | A list of toot ids indicating toots to be kept regardless of other settings. The ID of a toot is the last part of its individual URL. e.g. for [https://ausglam.space/@hugh/101294246770105799](https://ausglam.space/@hugh/101294246770105799) the id is `101294246770105799` | | toots_to_keep | A list of toot ids indicating toots to be kept regardless of other settings. The ID of a toot is the last part of its individual URL. e.g. for [https://ausglam.space/@hugh/101294246770105799](https://ausglam.space/@hugh/101294246770105799) the id is `101294246770105799` |
| hashtags_to_keep | A list of hashtags, where any toots with any of these hashtags will be kept regardless of age. Do not include the '#' symbol. Do remember the [rules for hashtags](https://docs.joinmastodon.org/user/posting/#hashtags) | | hashtags_to_keep | A list of hashtags, where any toots with any of these hashtags will be kept regardless of age. Do not include the '#' symbol. Do remember the [rules for hashtags](https://docs.joinmastodon.org/user/posting/#hashtags) |
| visibility_to_keep | Toots with any of the visibility settings in this list will be kept regardless of age. Options are: `public`, `unlisted`, `private`, `direct`. | | visibility_to_keep | Toots with any of the visibility settings in this list will be kept regardless of age. Options are: `public`, `unlisted`, `private`, `direct`. |