diff --git a/README.rst b/README.rst index b95f0fd..8864bfa 100644 --- a/README.rst +++ b/README.rst @@ -3,13 +3,16 @@ Shreddit Details ----------- -Uses the praw over at https://github.com/praw-dev/praw to do all the heavy lifting. +Shreddit is a Python command line program which will take a user's post history on the website Reddit (http://reddit.com) and after having the user edit a config file will systematically go through the user's history deleting one post/submission at a time utnil only those whitelisted remain. +Note: When it became known that post edits were *not* saved but post deletions *were* saved code was added to edit your post prior to deletion. In fact you can actually turn off deletion all together and just have lorem ipsum (or a message about Shreddit) but this will increase how long it takes the script to run as it will be going over all of your messages every run! +Basically it lets you maintain your normal reddit account while having your history scrubbed after a certain amount of time. +Uses PRAW over at https://github.com/praw-dev/praw to do all the heavy lifting. Usage ----------- - Just run `./schreddit` - You will need the `praw` Reddit Python library installed somewhere. I advise taking a read of https://github.com/praw-dev/praw#installation -- If you want custom edits (via lorem ipsum) then you must have the module installed. You can install it with pip using the command `sudo pip2 install loremipsum` on most operating systems. It may be called `pip` and not `pip2` - it depends on the versions of Python you have installed. +- If you want custom edits (via lorem ipsum) then you must have the module installed. You can install it with pip using the command `pip2 install loremipsum` on most operating systems. It may be called `pip` and not `pip2` - it depends on the versions of Python you have installed. Tit-bits ----------- @@ -30,16 +33,11 @@ Cron examples Caveats ----------- -- Only your previous 1,000 comments are accessable on Reddit. So good luck deleting the others. There may be ways to hack around this via iterating using sorting by top/best/controversial/new but for now I am unsure. I believe it best to set the script settings and run it as a cron job and then it won't be a problem unless you post *a lot* +- Only your previous 1,000 comments are accessable on Reddit. So good luck deleting the others. There may be ways to hack around this via iterating using sorting by top/best/controversial/new but for now I am unsure. I believe it best to set the script settings and run it as a cron job and then it won't be a problem unless you post *a lot*. I do, however, think that it may be a caching issue and perhaps after a certain time period your post history would, once again, become available as a block of 1,000. So you needn't despair yet! -- Would make life easier if Reddit just did a "DELETE * FROM abc_def WHERE user_id = 1337" +- Would make life easier if Reddit just did a "DELETE * FROM abc_def WHERE user_id = 1337", we are relying on Reddit admin words that they do not store edits. -- You require the reddit python library somewhere in your PYTHONPATH Donations ---------- -If you enjoy the added privacy from this script consider donating a tiny wee bit to myself, I will love you forever if you do! - -My Bitcoin address is: 17x7Zp3SKGMJu7S3MGa5ktKVDj4ZVAqB14 - -My PayPal email address is "napalm10" on the old Gmail! +My Bitcoin address: 17x7Zp3SKGMJu7S3MGa5ktKVDj4ZVAqB14