2020-07-04 14:23:39 +10:00
# 🥳 ==> 🧼 ==> 😇
2020-08-28 18:13:46 +10:00
[![PRs Welcome ](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square )](http://makeapullrequest.com)
2019-07-24 08:42:28 +10:00
2020-07-04 15:57:59 +10:00
**ephemetoot** is a Python command line tool for deleting old toots.
2020-09-07 09:51:06 +10:00
## 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 )
Install with pip:
```shell
pip install ephemetoot
```
Create a config file:
```shell
ephemetoot --init
```
Do a first run in `--test` mode:
```shell
ephemetoot --test
```
Find out about other options:
```shell
ephemetoot --help
```
2020-08-28 18:13:46 +10:00
## Documentation
2020-08-23 16:53:03 +10:00
* [Installation ](./docs/install.md )
* [Options ](./docs/options.md )
* [Upgrading and uninstalling ](./docs/upgrade.md )
2020-09-06 18:08:14 +10:00
You can also read the docs at [ephemetoot.hugh.run ](https://ephemetoot.hugh.run )
2020-08-23 16:53:03 +10:00
## Prior work
2020-04-20 20:14:58 +10:00
The initial `ephemetoot` script was based on [this tweet-deleting script ](https://gist.github.com/flesueur/bcb2d9185b64c5191915d860ad19f23f ) by [@flesueur ](https://github.com/flesueur )
2018-12-24 15:30:56 +11:00
2020-04-20 20:14:58 +10:00
`ephemetoot` relies heavily on the Mastodon.py package by [@halcy ](https://github.com/halcy )
2018-12-24 15:30:56 +11:00
2020-08-23 16:53:03 +10:00
## Usage
2020-05-09 14:45:38 +10:00
You can use `ephemetoot` to delete [Mastodon ](https://github.com/tootsuite/mastodon ) toots that are older than a certain number of days (default is 365). Toots can optionally be saved from deletion if:
2020-07-04 14:23:39 +10:00
* they are pinned; or
* they include certain hashtags; or
2020-04-20 20:14:58 +10:00
* they have certain visibility; or
* they are individually listed to be kept
2018-12-24 15:30:56 +11:00
2020-08-23 16:53:03 +10:00
## Contributing
2020-08-24 21:22:39 +10:00
For all bugs, suggestions, pull requests or other contributions, please check the [contributing guide ](./docs/contributing.md ).
2018-12-24 15:30:56 +11:00
2020-08-23 16:53:03 +10:00
## License
This project and all contributions are [licensed ](./LICENSE ) under the GPL 3.0 or future version