Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 57 lines (40 sloc) 1.782 kb
b29fd99 @bboe Updated the README due to the addition of the WIKI pages.
bboe authored
1 # Introduction
e0727f7 @bboe Updated README and cleaned up imports.
bboe authored
2 This is a Python wrapper for Reddit's API, aiming to be as easy to use as
8a5169f Added easy_install, fixed amount of submissions in intro.
Vinny Diehl authored
3 possible. Here's a quick peek, getting the first 5 submissions from the 'hot'
e0727f7 @bboe Updated README and cleaned up imports.
bboe authored
4 section of the 'opensource' subreddit.
5b0221f @tmelz polished up code and added README
authored
5
a377f53 @bboe Added set_flair_csv function along with README example and tests.
bboe authored
6 ```python
7 import reddit
ff6c3a9 @bboe Quote consistency.
bboe authored
8 r = reddit.Reddit(user_agent='my_cool_application')
a377f53 @bboe Added set_flair_csv function along with README example and tests.
bboe authored
9 submissions = r.get_subreddit('opensource').get_hot(limit=5)
759be65 @bboe Corrected README example.
bboe authored
10 [str(x) for x in submissions]
a377f53 @bboe Added set_flair_csv function along with README example and tests.
bboe authored
11 ```
0305f9c @tmelz added some __doc__ and __name__, enhanced README
authored
12
8a5169f Added easy_install, fixed amount of submissions in intro.
Vinny Diehl authored
13 This will display something similar to the following:
0305f9c @tmelz added some __doc__ and __name__, enhanced README
authored
14
a377f53 @bboe Added set_flair_csv function along with README example and tests.
bboe authored
15 ```python
759be65 @bboe Corrected README example.
bboe authored
16 ['10 :: Gun.io Debuts Group Funding for Open Source Projects\n Gun.io',
17 '24 :: Support the Free Software Foundation',
18 '67 :: The 10 Most Important Open Source Projects of 2011',
19 '2 :: Open-source webOS is dead on arrival ',
20 '85 :: Plan 9 - A distributed OS with a unified communication protocol and I/O driver model. Wow.']
a377f53 @bboe Added set_flair_csv function along with README example and tests.
bboe authored
21 ```
0305f9c @tmelz added some __doc__ and __name__, enhanced README
authored
22
b29fd99 @bboe Updated the README due to the addition of the WIKI pages.
bboe authored
23 # Installation
e934cc1 @tmelz uploaded to pip, added extra install options to README
authored
24 You can install via `pip`
25
26 pip install reddit
27
8a5169f Added easy_install, fixed amount of submissions in intro.
Vinny Diehl authored
28 Or via `easy-install`
29
30 easy_install reddit
31
e934cc1 @tmelz uploaded to pip, added extra install options to README
authored
32 Or via `setup.py`
33
34 python setup.py install
35
36
b29fd99 @bboe Updated the README due to the addition of the WIKI pages.
bboe authored
37 # Examples and Configuration
38 For a number of simple code examples, details on the Reddit API
39 Wrapper'sconfiguration files and links to projects which use this package see
40 the [wiki](https://github.com/mellort/reddit_api/wiki).
5b0221f @tmelz polished up code and added README
authored
41
33770e3 @tmelz updated readme with example applications
authored
42
b29fd99 @bboe Updated the README due to the addition of the WIKI pages.
bboe authored
43 # FAQ
6acc444 @tmelz cleaned up code, added 'questions' to readme
authored
44 > Why is everything so slow?
33770e3 @tmelz updated readme with example applications
authored
45
80b0504 @tmelz reorganization of code, code cleanup
authored
46 Usually that has to do with how fast reddit is responding at the moment. Check
47 the site, see if it's responding quicker when accessing it in your browser.
e0727f7 @bboe Updated README and cleaned up imports.
bboe authored
48 Otherwise, we respect the "no more than one API call per two seconds" rule, so
49 if you're trying to do a bunch of quick requests in succession you're going to
50 be spaced out to one call per second. If you're having a specific issue besides
51 something covered by one of those two things, please let us know (or file a
52 ticket) and we'll check it out.
6acc444 @tmelz cleaned up code, added 'questions' to readme
authored
53
0305f9c @tmelz added some __doc__ and __name__, enhanced README
authored
54
b29fd99 @bboe Updated the README due to the addition of the WIKI pages.
bboe authored
55 # License
ae39856 @tmelz added gplv3 license
authored
56 All of the code contained here is licensed by the GNU GPLv3.
Something went wrong with that request. Please try again.