ft: readme + instructions
This commit is contained in:
21
README.md
Normal file
21
README.md
Normal file
@@ -0,0 +1,21 @@
|
||||
# Tum(bler del)eter
|
||||
|
||||
Python script that uses the Tumblr API to remove all "empty reblogs" for a tumblr account's main blog.
|
||||
|
||||
Empty reblogs are defined as posts on the account where both of the following hold:
|
||||
1) the last addition in the reblog trail is NOT made by the account.
|
||||
2) the account did not add any tags.
|
||||
|
||||
# Running
|
||||
|
||||
You're going to need to get authentication for the Tumblr API.
|
||||
First set up an [application](https://www.tumblr.com/oauth/apps).
|
||||
|
||||
Then copy the `env.example` file to `.env` and populate the four required values.
|
||||
After that just run the program using `uv run main.py` and give it time to run.
|
||||
|
||||
# Rate limits
|
||||
|
||||
Tumblr's API has hard-coded rate limits, so the script will wait on timeout and try again at a later point.
|
||||
Note that as a result, running the script may take a while (especially on blogs with a large number of posts).
|
||||
|
||||
4
env.example
Normal file
4
env.example
Normal file
@@ -0,0 +1,4 @@
|
||||
CONSUMER_KEY=""
|
||||
CONSUMER_SECRET=""
|
||||
OAUTH_TOKEN=""
|
||||
OAUTH_SECRET=""
|
||||
Reference in New Issue
Block a user