-
Notifications
You must be signed in to change notification settings - Fork 35
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
new: dev: use template to generate help section on readme.
after install cogapp, just run this command to generate readme file. ```python -m cogapp -d ./README.md.tmpl > ./README.md```
- Loading branch information
1 parent
a61e6a7
commit cd5292e
Showing
3 changed files
with
68 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,59 @@ | ||
# Export Saved Reddit Posts | ||
|
||
Exports saved and/or upvoted Reddit posts into a HTML file that is ready to be imported into Google Chrome. Sorts items into folders by subreddit. | ||
|
||
## Requirements | ||
* [Python 3.x](https://www.python.org/downloads/) | ||
* [pip](https://pip.pypa.io/en/stable/installing/) | ||
* [git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git) (recommended) | ||
|
||
## Installation | ||
|
||
First, make sure you have [Python 3.x](https://www.python.org/downloads/), [pip](https://pip.pypa.io/en/stable/installing/), and [git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git) installed on your machine. | ||
|
||
Run the following in your command prompt to install: | ||
|
||
git clone https://github.com/csu/export-saved-reddit.git | ||
cd export-saved-reddit | ||
pip install -r requirements.txt | ||
|
||
To install without git, [download the source code from GitHub](https://github.com/csu/export-saved-reddit/archive/master.zip), extract the archive, and follow the steps above beginning from the second line. | ||
|
||
## Usage | ||
1. [Make a new Reddit](https://www.reddit.com/prefs/apps) app to get a `client id` and a `client secret`. | ||
|
||
- Scroll to the bottom of the page and click "create app" | ||
- You can name the app anything (e.g. "export-saved"). Select the "script" option. Put anything for the redirect URI (e.g. https://christopher.su). | ||
- After creating the app, the client id will appear under the app name while the client secret will be labeled "secret". | ||
|
||
2. In the `export-saved-reddit` folder, rename the `AccountDetails.py.example` file to `AccountDetails.py`. | ||
3. Open the `AccountDetails.py` in a text editor and enter your Reddit username, password, client id, client secret within the corresponding quotation marks. Save and close the file. | ||
4. Back in your shell, run `python export_saved.py` in the `export-saved-reddit` folder. This will run the export, which will create `chrome-bookmarks.html` and `export-saved.csv` files containing your data in the same folder. | ||
|
||
### Additional Options | ||
|
||
[[[cog | ||
import subprocess | ||
import cogapp as cog | ||
|
||
def indent(text, width=4): | ||
return "\n".join((" "*width + line) for line in text.splitlines()) | ||
|
||
text = subprocess.check_output("python ./export_saved.py --help", shell=True) | ||
cog_obj = cog.Cog() | ||
cog_obj.prout(indent(text.decode('utf8'))) | ||
]]] | ||
[[[end]]] | ||
|
||
## Updating | ||
To update the script to the latest version, enter the `export-saved-reddit` folder in your shell/command prompt and enter the following: | ||
|
||
git pull | ||
|
||
## Help | ||
If you have any questions or comments, please [open an issue on GitHub](https://github.com/csu/export-saved-reddit/issues) or [contact me](https://christopher.su/about/). | ||
|
||
## [Contributing](https://github.com/csu/export-saved-reddit/blob/master/CONTRIBUTORS.md) | ||
[![Build Status](https://travis-ci.org/csu/export-saved-reddit.svg?branch=master)](https://travis-ci.org/csu/export-saved-reddit) | ||
|
||
If you would like to contribute, check out the project's [open issues](https://github.com/csu/export-saved-reddit/issues). [Pull requests](https://github.com/csu/export-saved-reddit/pulls) are welcome. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -2,3 +2,4 @@ | |
pytest==3.0.6 | ||
pytest-cov==2.4.0 | ||
flake8==3.3.0 | ||
cogapp==2.5.1 |