ephemetoot-eliminare-vecchi.../README.md

# 🥳 ==> 🧼 ==> 😇
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)  

**ephemetoot** is a Python command line tool for deleting old toots.

## 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
```

## Documentation
* [Installation](./docs/install.md)
* [Options](./docs/options.md)
* [Upgrading and uninstalling](./docs/upgrade.md)

You can also read the docs at [ephemetoot.hugh.run](https://ephemetoot.hugh.run)

## Prior and related work
The initial `ephemetoot` script was based on [this tweet-deleting script](https://gist.github.com/flesueur/bcb2d9185b64c5191915d860ad19f23f) by [@flesueur](https://github.com/flesueur)

`ephemetoot` relies heavily on the Mastodon.py package by [@halcy](https://github.com/halcy)

Looks like [Gabriel Augendre had the same idea](https://git.augendre.info/gaugendre/cleantoots). You might prefer to use Gabriel's `cleantoots` instead.

## Usage
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:
* they are pinned; or
* they include certain hashtags; or
* they have certain visibility; or
* they are individually listed to be kept

## Contributing
ephemetoot is packaged using `poetry` and tested using `pytest`.

For all bugs, suggestions, pull requests or other contributions, please check the [contributing guide](./docs/contributing.md).

## License
This project and all contributions are [licensed](./LICENSE) under the GPL 3.0 or future version
update templates - Add pull request template - Update issue template directory name - minor edits to README ahead of community docs improvements 2020-07-04 06:23:39 +02:00			`# 🥳 ==> 🧼 ==> 😇`
update docs for version 3 2020-08-28 10:13:46 +02:00			`[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)`
add documentation about utf-8 errors 2019-07-24 00:42:28 +02:00
make minor formatting changes to docs 2020-07-04 07:57:59 +02:00			`ephemetoot is a Python command line tool for deleting old toots.`

improve instructions - README now has a 'quickstart' section - config file creation clarifies not to include the '#' in hashtag lists 2020-09-07 01:51:06 +02: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`
			```

update docs for version 3 2020-08-28 10:13:46 +02:00			`## Documentation`
add --retry-mins option This commit adds a --retry-mins option to enable users to choose how many minutes pass between attempts to retry a toot deletion when there is an error. Also re-organises documentation and bumps version to 2.6. 2020-08-23 08:53:03 +02:00			`* [Installation](./docs/install.md)`
			`* [Options](./docs/options.md)`
			`* [Upgrading and uninstalling](./docs/upgrade.md)`

prepare for v3.0.0 - update documentation - bump version 2020-09-06 10:08:14 +02:00			`You can also read the docs at [ephemetoot.hugh.run](https://ephemetoot.hugh.run)`

add reference to `cleantoots` Resolves #71 2021-08-06 03:36:10 +02:00			`## Prior and related work`
use setuptools and add multi-user Resolves #20 - now uses setuptools for easy installation with pip Resolves #13 - can now manage multiple accounts Config file is now in YAML and is passed to script with --config flag Can now execute from anywhere 2020-04-20 12:14:58 +02:00			The initial `ephemetoot` script was based on [this tweet-deleting script](https://gist.github.com/flesueur/bcb2d9185b64c5191915d860ad19f23f) by [@flesueur](https://github.com/flesueur)
first commit 2018-12-24 05:30:56 +01:00
use setuptools and add multi-user Resolves #20 - now uses setuptools for easy installation with pip Resolves #13 - can now manage multiple accounts Config file is now in YAML and is passed to script with --config flag Can now execute from anywhere 2020-04-20 12:14:58 +02:00			`ephemetoot` relies heavily on the Mastodon.py package by [@halcy](https://github.com/halcy)
first commit 2018-12-24 05:30:56 +01:00
add reference to `cleantoots` Resolves #71 2021-08-06 03:36:10 +02:00			Looks like [Gabriel Augendre had the same idea](https://git.augendre.info/gaugendre/cleantoots). You might prefer to use Gabriel's `cleantoots` instead.

add --retry-mins option This commit adds a --retry-mins option to enable users to choose how many minutes pass between attempts to retry a toot deletion when there is an error. Also re-organises documentation and bumps version to 2.6. 2020-08-23 08:53:03 +02:00			`## Usage`
Simplify config options and improve error handling Fix #21 2020-05-09 06:45:38 +02: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:
update templates - Add pull request template - Update issue template directory name - minor edits to README ahead of community docs improvements 2020-07-04 06:23:39 +02:00			`* they are pinned; or`
			`* they include certain hashtags; or`
use setuptools and add multi-user Resolves #20 - now uses setuptools for easy installation with pip Resolves #13 - can now manage multiple accounts Config file is now in YAML and is passed to script with --config flag Can now execute from anywhere 2020-04-20 12:14:58 +02:00			`* they have certain visibility; or`
			`* they are individually listed to be kept`
first commit 2018-12-24 05:30:56 +01:00
add --retry-mins option This commit adds a --retry-mins option to enable users to choose how many minutes pass between attempts to retry a toot deletion when there is an error. Also re-organises documentation and bumps version to 2.6. 2020-08-23 08:53:03 +02:00			`## Contributing`
include tests in pypi package This commit adds the tests directory when packaging up for pypi. This is in response to a request from @pacoesteban (GitHub user) who is the maintainer for the OpenBSD port of ephemetoot. 2020-09-26 05:42:40 +02:00			ephemetoot is packaged using `poetry` and tested using `pytest`.

re-organise docs 2020-08-24 13:22:39 +02:00			`For all bugs, suggestions, pull requests or other contributions, please check the [contributing guide](./docs/contributing.md).`
first commit 2018-12-24 05:30:56 +01:00
add --retry-mins option This commit adds a --retry-mins option to enable users to choose how many minutes pass between attempts to retry a toot deletion when there is an error. Also re-organises documentation and bumps version to 2.6. 2020-08-23 08:53:03 +02:00			`## License`
			`This project and all contributions are [licensed](./LICENSE) under the GPL 3.0 or future version`