From f7d7e34d2dd197571e8d0f345cd92c1c7096f3c5 Mon Sep 17 00:00:00 2001 From: Scott Date: Mon, 28 Nov 2016 16:17:15 -0600 Subject: [PATCH 1/5] Makes it easier for users to get the default config --- .gitignore | 1 + setup.py | 6 +-- shreddit/app.py | 11 ++++- shreddit/shreddit.yml.example | 83 +++++++++++++++++++++++++++++++++++ 4 files changed, 97 insertions(+), 4 deletions(-) create mode 100644 shreddit/shreddit.yml.example diff --git a/.gitignore b/.gitignore index e336702..84bf6ca 100644 --- a/.gitignore +++ b/.gitignore @@ -1,5 +1,6 @@ shreddit.yml praw.ini +Makefile # Docs docs/_build/ diff --git a/setup.py b/setup.py index c6b8ee3..fc369f2 100644 --- a/setup.py +++ b/setup.py @@ -4,7 +4,7 @@ from setuptools import setup from codecs import open from os import path -VERSION = "2.0.0" +VERSION = "2.1.0" DESCRIPTION = " Remove your comment history on Reddit as deleting an account does not do so." here = path.abspath(path.dirname(__file__)) @@ -27,8 +27,8 @@ setup( "Intended Audience :: End Users/Desktop", "Programming Language :: Python"], packages=["shreddit"], - install_requires=["arrow", "backports-abc", "decorator", "praw", "PyYAML", - "requests", "six", "tornado", "update-checker", "wheel"], + install_requires=["arrow", "backports-abc", "praw", "PyYAML", "requests", "six", "tornado"], + package_data={"shreddit": ["shreddit.yml.example"]}, entry_points={ "console_scripts": [ "shreddit=shreddit.app:main" diff --git a/shreddit/app.py b/shreddit/app.py index 0eeaca8..b25c2d5 100644 --- a/shreddit/app.py +++ b/shreddit/app.py @@ -3,6 +3,8 @@ import argparse import yaml import logging +import os +import pkg_resources from shreddit import default_config from shreddit.oauth import oauth_test from shreddit.shredder import Shredder @@ -19,7 +21,14 @@ def main(): oauth_test(args.praw) return - with open(args.config or "shreddit.yml") as fh: + config_filename = args.config or "shreddit.yml" + if not os.path.isfile(config_filename): + print("No configuration file could be found. Paste the following into a file called \"shreddit.yml\" and " \ + "try running shreddit again:\n\n") + print(pkg_resources.resource_string("shreddit", "shreddit.yml.example")) + return + + with open(config_filename) as fh: # Not doing a simple update() here because it's preferable to only set attributes that are "whitelisted" as # configuration options in the form of default values. user_config = yaml.safe_load(fh) diff --git a/shreddit/shreddit.yml.example b/shreddit/shreddit.yml.example new file mode 100644 index 0000000..38088a8 --- /dev/null +++ b/shreddit/shreddit.yml.example @@ -0,0 +1,83 @@ +--- +# Login details for Reddit. Fill out if you don't wish +# to be prompted for a login every time you run Shreddit. +### NOTE: This may be deprecated as you can specify in praw.ini instead +username: +password: + +# How many hours of comments you want to keep +# 24 hours in a day, +# 168 hours in a week, +# 672 hours in two fortnights, +# 720 hours in a month (30 days), +# 8766 hours in a year (365.25 days) +hours: 24 + +# Max score, higher than this and it'll be kept. +max_score: 100 + +# Options: new, top, controversial, more? +sort: new + +# Enables print statements to notify you of what's going on +verbose: True + +# Removes your vote before deleting the item +clear_vote: False + +# Options: comments, submitted, overview +# See: https://github.com/mellort/reddit_api/blob/master/reddit/objects.py#L359 +# Overview: both submissions and comments. Comments / Submitted are as expected +item: overview + +# Anything in this list won't be deleted, coma delimited +# spaces should work as .strip() is called after splitting +# on comma. +whitelist: [AskScience, TheCulture, redditdev, programming, charity, netsec] + +# If you want any specific posts to be whitelisted stick 'em in here +whitelist_ids: [] + +# If you set this then no editing or deleting will be done +# but the output from the program will be shown as an example +trial_run: False + +# Don't delete but *do* edit, could prove... interesting to see a comment +# with 5000 upvotes and it's just a lorem ipsum! +edit_only: False + +# Ignore distinguished comments. +whitelist_distinguished: True + +# Ignore gilded (gold) comments +whitelist_gilded: True + +# Delete everything older that this date, **This ignores whitelists**. +# Can be used as a second deletion, as in "delete items older than 24 hours +# except on whitelisted subreddits but after 3 months delete everything. +nuke_hours: 720 + +# Save a copy to disk of comments and posts before deleting them. +keep_a_copy: False +save_directory: /tmp + +# Replacement text format +# Defines what you want to edit deleted content with pre-deletion (to ensure +# it's not saved in their database). +# Default: Random string. But this can be detected as spam in some cases. +# options: [random, dot, "user entered string"] +replacement_format: random + +# Debug level, how much output you want +# See: https://docs.python.org/3/library/logging.html#logging-levels +debug: DEBUG + +# Define your own wordlist to use as substitution text when +# replacement_format == random +wordlist: [] + +# Batch cooldown +# This controls how long (in seconds) to wait between each set of 1000 deletions. +batch_cooldown: 10 + +# vim: syntax=yaml ts=2 From f71b99d5388703b28b28fcdf25f26d45a6c56854 Mon Sep 17 00:00:00 2001 From: Scott Date: Mon, 28 Nov 2016 16:17:36 -0600 Subject: [PATCH 2/5] Freezes up-to-date requirements --- requirements.txt | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/requirements.txt b/requirements.txt index b45e408..92b2c37 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,10 +1,10 @@ -arrow -decorator +arrow==0.9.0 +decorator==4.0.10 praw==3.6.0 -PyYAML -requests -six +PyYAML==3.12 +requests==2.12.1 +six==1.10.0 backports-abc==0.4 tornado==4.3 -update-checker==0.11 +update-checker==0.15 wheel==0.24.0 From 7fab5278dd9b46e584b083e3c7673b8a923492ed Mon Sep 17 00:00:00 2001 From: Scott Date: Mon, 28 Nov 2016 17:22:33 -0600 Subject: [PATCH 3/5] Updates the README with pip installation info --- README.md | 169 ++++++++++++++++++++++++++---------------------------- 1 file changed, 82 insertions(+), 87 deletions(-) diff --git a/README.md b/README.md index afdfc08..74dce83 100644 --- a/README.md +++ b/README.md @@ -1,112 +1,107 @@ -Shreddit -======== - -Description ------------ -Shreddit is a Python command line program which will take a user's post history -on the website [Reddit](http://reddit.com), and will systematically go through -the user's history deleting one post/submission at a time until 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! - -It allows you to maintain your normal reddit account while having your history +# Shreddit + +Shreddit is a Python command line program which will take a user's post history on the website +[Reddit](http://reddit.com), and will systematically go through the user's history deleting one post/submission at a +time until only those whitelisted remain. It allows you to maintain your normal reddit account while having your history scrubbed after a certain amount of time. -User Login deprecation ----------------------- -Reddit intends to disable username-password based authentication to access its -APIs in the near future. You can specify your username and password in the -`shreddit.yml` or the `praw.ini` to make it work **FOR NOW**. But consider -looking at the [OAuth2 instructions](#oauth2-instructions) if you intend to use -this program in the future. - -Installation ([Click here for Windows instructions](#for-windows-users)) ------------------------------------------------------------------------- -1. Clone the repository -2. Run `python setup.py install`. Usually this is run in the context of a - virtualenv or with administrative permissions for system-wide installation. - virtual environment) -3. Copy `shreddit.yml.example` to `shreddit.yml` and edit it to your liking. - - Make sure you specify your credentials in the file. - - See the [OAuth2 instructions](#oauth2-instructions) if you don't want to - use username-password based authentication. - -- It's useful to have it run as an event, you can set this up as you like but I - suggest `cron` via `crontab -e` and adding a line such as - `@hourly cd $HOME/Shreddit && source bin/activate && shreddit` See below for - more. -- Adding your password to the praw.ini and adding the additional output line - can provide extra debugging help. - -Cron examples -------------- - -- Run `crontab -e` to edit your cron file. If you have access to something like - vixie-cron then each user can have their own personal cron job! +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. + +## User Login deprecation + +Reddit intends to disable username-password based authentication to access its APIs in the near future. You can specify +your username and password in the `shreddit.yml` or the `praw.ini` to make it work **FOR NOW**. But consider looking at +the [OAuth2 instructions](#oauth2-instructions) if you intend to use this program in the future. + +## Pip Installation + +`pip install -U shreddit` will install the package and its dependencies, and it will add a `shreddit` command line +utility to your PATH. This is typically either run in a virtualenv or using administrative privileges for global +installation. + +## Manual Installation + +1. Clone the `shreddit` repository to a directory. +2. From the directory, run `pip install -r requirements.txt` +3. Run `python setup.py install` to install the package and the `shreddit` command line utility. This is typically + either run in a virtualenv or using administrative privileges for global installation. + +## Usage + +After installing the `shreddit` command line utility, the first step is setting up the tool's configuration file. Simply +typing `shreddit` will print a message with an example config. Copy the message from `---` onwards and save it as +`shreddit.yml`. Now, the tool may be used by simply typing `shreddit` from this directory. Alternatively, if you named +the configuration file something different such as `config.yml`, you may use it with `shreddit -c config.yml`. + +### Automating + +The easiest way to automate this tool after the first run is by using the cron utility. Run `crontab -e` to edit your +user's crontab settings. + +**Examples:** - Run every hour on the hour - `0 * * * * shreddit -c ` + `0 * * * * shreddit -c ` - Run at 3am every morning - `0 3 * * * shreddit -c ` + `0 3 * * * shreddit -c ` - Run once a month on the 1st of the month - `0 0 1 * * shreddit -c ` + `0 0 1 * * shreddit -c ` + +If virtualenv was used, be sure to add `source /full/path/to/venv/bin/activate &&` before the command. For example: -If virtualenv was used, be sure to add -`source /full/path/to/venv/bin/activate &&` -before the command. For example: +`0 * * * * source /full/path/to/venv/bin/activate && shreddit -c ` -`0 * * * * source /full/path/to/venv/bin/activate && -shreddit -c ` +### Command Line Options -For Windows users ------------------ +``` +$ shreddit --help +usage: shreddit [-h] [-c CONFIG] [-p PRAW] [-t] + +Command-line frontend to the shreddit library. + +optional arguments: + -h, --help show this help message and exit + -c CONFIG, --config CONFIG + Config file to use instead of the default shreddit.yml + -p PRAW, --praw PRAW PRAW config (if not ./praw.ini) + -t, --test-oauth Perform OAuth test and exit +``` + +## For Windows users 1. Make sure you have Python installed. [Click here for the Python download page](https://www.python.org/downloads/). - - **Note:** Install either `python 2.x` or `python 3.x`, not both. -2. Clone the repository (or download and extract the zip file) -3. Open command prompt to the folder with the zip file (Shreddit-master.zip), - and type `pip install -U Shreddit-master.zip` -4. Open `shreddit.yml.example` in the zip edit it to your liking, and rename the - file to `shreddit.yml`. - - Make sure you specify credentials in the file. - - See the [OAuth2 instructions](#oauth2-instructions) if you don't want to - use username-password based authentication. -5. Type `shreddit` in the open command prompt window to run the program. - -OAuth2 Instructions -------------------- + - **Note:** Install either `python 2.x` or `python 3.x`, not both. +2. Follow the [pip installation](#pip-installation) instructions. +3. Open a new command prompt and verify that the `shreddit` command works before moving on to the [usage](#usage) + section. + +## OAuth2 Instructions 1. Visit: https://www.reddit.com/prefs/apps 2. Click on 'Create app'. - - Fill in the name and select the 'script' option - - Under "redirect uri" put http://127.0.0.1:65010 -3. Copy from or rename `praw.ini.example` to `praw.ini` and open it. Enter the - values from the Reddit page. - - oauth\_client\_id = { The ID displayed next to the icon thingy (under + - Fill in the name and select the 'script' option + - Under "redirect uri" put http://127.0.0.1:65010 +3. Copy from or rename `praw.ini.example` to `praw.ini` and open it. Enter the values from the Reddit page. + - oauth\_client\_id = { The ID displayed next to the icon thingy (under "personal use script") } - - oauth\_client\_secret = { The secret } - - oauth\_redirect\_uri = http://127.0.0.1:65010 - - Save the file. + - oauth\_client\_secret = { The secret } + - oauth\_redirect\_uri = http://127.0.0.1:65010 + - Save the file. 4. Run `python get_secret.py` in the command prompt. 5. Your browser will open to a page on Reddit listing requested permissions. 6. Click 'Allow'. -Caveats -------- +## Caveats -- Certain limitations in the Reddit API and the PRAW library make it difficult - to delete more than 1,000 comments. While deleting >1000 comments is planned, - it is necessary right now to rerun the program until they are all deleted. +- Certain limitations in the Reddit API and the PRAW library make it difficult to delete more than 1,000 comments. + While deleting >1000 comments is planned, it is necessary right now to rerun the program until they are all deleted. -- We are relying on Reddit admin words that they do not store edits, deleted - posts are still stored in the database they are merely inaccessible to the - public. +- We are relying on Reddit admin words that they do not store edits, deleted posts are still stored in the database + they are merely inaccessible to the public. From 1ed2b7ea89ab4068071049f9c8d2eba7bfd6fc9d Mon Sep 17 00:00:00 2001 From: Scott Date: Mon, 28 Nov 2016 17:22:58 -0600 Subject: [PATCH 4/5] Updates setup.py with origin repo author info --- setup.py | 9 +++------ 1 file changed, 3 insertions(+), 6 deletions(-) diff --git a/setup.py b/setup.py index fc369f2..8831329 100644 --- a/setup.py +++ b/setup.py @@ -12,17 +12,14 @@ here = path.abspath(path.dirname(__file__)) with open(path.join(here, "README.md"), encoding='utf-8') as filein: long_description = filein.read() -with open(path.join(here, "requirements.txt"), encoding="utf-8") as filein: - requirements = [line.strip() for line in filein.readlines()] - setup( name="shreddit", version=VERSION, description=DESCRIPTION, long_description=long_description, - url="https://github.com/scott-hand/Shreddit", - author="Scott Hand", - author_email="scott@vkgfx.com", + url="https://github.com/x89/Shreddit", + author="David John", + author_email="david@vaunt.eu", classifiers=["Development Status :: 4 - Beta", "Intended Audience :: End Users/Desktop", "Programming Language :: Python"], From 574dab8bb57aa8934d552a0b4829e554f7bc9376 Mon Sep 17 00:00:00 2001 From: Scott Date: Mon, 28 Nov 2016 17:30:52 -0600 Subject: [PATCH 5/5] Gets package ready for PyPI --- setup.cfg | 2 ++ setup.py | 2 +- 2 files changed, 3 insertions(+), 1 deletion(-) create mode 100644 setup.cfg diff --git a/setup.cfg b/setup.cfg new file mode 100644 index 0000000..b88034e --- /dev/null +++ b/setup.cfg @@ -0,0 +1,2 @@ +[metadata] +description-file = README.md diff --git a/setup.py b/setup.py index 8831329..3b5497c 100644 --- a/setup.py +++ b/setup.py @@ -4,7 +4,7 @@ from setuptools import setup from codecs import open from os import path -VERSION = "2.1.0" +VERSION = "3.0.0" DESCRIPTION = " Remove your comment history on Reddit as deleting an account does not do so." here = path.abspath(path.dirname(__file__))