Added doc of -r switch to README.md

This commit is contained in:
jeancf 2020-03-17 15:19:06 +01:00
parent 3201cc8169
commit 01b08542ec

View File

@ -4,6 +4,10 @@ that broke when Twitter refreshed their web UI in July 2019.
Instead twoot is self contained and handles all the processing. Instead twoot is self contained and handles all the processing.
**UPDATE 17 MAR 2020** Added command line switch (`-r`) to also post
reply-to tweets on the mastodon account. They will not be included by
default anymore.
**UPDATE 06 MAR 2020** Added functionality to automatically get images **UPDATE 06 MAR 2020** Added functionality to automatically get images
from tweets considered as "sensitive content" from tweets considered as "sensitive content"
@ -20,13 +24,14 @@ of last week.
* Specify maximum age of tweet to be considered * Specify maximum age of tweet to be considered
* Specify minimum delay before considering a tweet for upload * Specify minimum delay before considering a tweet for upload
* Remember tweets already tooted to prevent double posting * Remember tweets already tooted to prevent double posting
* Can optionally post post reply-to tweets on the mastodon account
# usage # usage
``` ```
twoot.py [-h] -t <twitter account> -i <mastodon instance> -m <mastodon twoot.py [-h] -t <twitter account> -i <mastodon instance> -m <mastodon
account> -p <mastodon password> [-a <max age in days>] account> -p <mastodon password> [-r]
[-d <min delay in mins>] [-a <max age in days>] [-d <min delay in mins>]
``` ```
# arguments # arguments
@ -40,6 +45,7 @@ is @superduperbot@botsin.space
| -i | Mastodon instance domain name | `botsin.space` | Yes | | -i | Mastodon instance domain name | `botsin.space` | Yes |
| -m | Mastodon username | `superduperbot` | Yes | | -m | Mastodon username | `superduperbot` | Yes |
| -p | Mastodon password | `my_Sup3r-S4f3*pw` | Yes | | -p | Mastodon password | `my_Sup3r-S4f3*pw` | Yes |
| -r | Post reply-to tweets (ignored by default) | *N/A* | No |
| -a | Max. age of tweet to post (in days) | `1` | No | | -a | Max. age of tweet to post (in days) | `1` | No |
| -d | Min. delay before posting new tweet (in minutes) | `15` | No | | -d | Min. delay before posting new tweet (in minutes) | `15` | No |
@ -51,7 +57,7 @@ Default min delay is 0 minutes.
Make sure python3 is installed. Make sure python3 is installed.
Twoot depends on sqlite3, beautifulsoup4 and mastodon python module: `sudo pip install beautifulsoup4 Mastodon.py` Twoot depends on beautifulsoup4 and mastodon python module: `sudo pip install beautifulsoup4 Mastodon.py`
In your user folder, execute `git clone https://gitlab.com/jeancf/twoot.git` In your user folder, execute `git clone https://gitlab.com/jeancf/twoot.git`
to clone repo with twoot.py script. to clone repo with twoot.py script.