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

update docs for v2.5 

Updates README for new options
Updates version number
This commit is contained in:
Hugh Rundle 2020-07-18 18:04:27 +10:00
parent 62db64a73f
commit a777e18e12
2 changed files with 12 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -109,7 +109,7 @@ For a short description of all available options, run `ephemetoot --help` from t
It is **strongly recommended** that you do a test run before using `ephemetoot` live. There is no "undo"!
## Running in test mode
## Running in test mode (--test)
To do a test-run without actually deleting anything, run the script with the `--test` flag:
```shell
@ -125,7 +125,7 @@ ephemetoot
Depending on how many toots you have and how long you want to keep them, it may take a minute or two before you see any results.
## Specifying the config location
## Specifying the config location (--config)
By default ephemetoot expects there to be a config file called `config.yaml` in the directory from where you run the `ephemetoot` command. If you want to call it from elsewhere (e.g. with `cron`), you need to specify where your config file is:
@ -133,18 +133,24 @@ By default ephemetoot expects there to be a config file called `config.yaml` in
ephemetoot --config '~/directory/subdirectory/config.yaml'
```
## Slow down deletes to match API limit
## Slow down deletes to match API limit (--pace)
With the `--pace` flag, delete actions are slowed so that the API limit is never reached, using [`Mastodon.py`'s 'pace' method](https://mastodonpy.readthedocs.io/en/stable/index.html?highlight=pace#mastodon.Mastodon.__init__). This is recommended for your first run, as unless you have tooted fewer than 30 times you are guaranteed to hit the API limit for deletions the first time you run `ephemetoot`. If you do not toot very often on most days, it is probably more efficient to use the default behaviour for daily runs after the first time, but you can use `--pace` every time if you prefer.
## Hide skipped items
## Hide skipped items (--hide_skipped)
If you skip a lot of items (e.g. you skip direct messages) it may clutter your log file to list these every time you run the script. You can suppress them from the output by using the `--hide_skipped` flag.
## Include datestamp with every action
## Include datestamp with every action (--datestamp)
If you want to know exactly when each delete action occured, you can use the `--datestamp` flag to add a datestamp to the log output. This is useful when using `--pace` so you can see the rate you have been slowed down to.
## Only archive deleted toots (--archive-deleted)
If you provide a value for `archive` in your config file, the default is that all toots will be archived in that location, regardless of whether or not it is being deleted. i.e. it will create a local archive of your entire toot history. If you run ephemetoot with the `--test` flag, this allows you to use create an archive without even deleting anything.
You can use the `--archive-deleted` flag to only archive deleted toots instead.
## Combining flag options
You can use several flags together:

2
setup.py
View File

@ -2,7 +2,7 @@ from setuptools import setup, find_packages
setup(
name="ephemetoot",
version="2.3.1",
version="2.5",
url="https://github.com/hughrun/ephemetoot",
license="GPL-3.0-or-later",
packages=find_packages(),