Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Update documentation

  • Loading branch information...
commit 3d1eaa7974b1eb64123a8547ef666612b7dbbc5c 1 parent 0483e4d
@zachwill authored
View
71 README.md
@@ -2,3 +2,74 @@ dribbble
========
A simple Python wrapper for the [Dribbble API](http://dribbble.com/api).
+
+
+Installation
+------------
+
+The easiest way to get the API is by using `pip`:
+
+```
+pip install dribbble
+```
+
+
+Usage
+-----
+
+The `dribbble` wrapper intends to make the API as easy to use as
+possible.
+
+```python
+
+>>> import dribbble as d
+
+# Get info on a player
+>>> d.info('simplebits')
+
+# Alternative, cooler name for getting info
+>>> d.scout('simplebits')
+
+# See the current community shots
+>>> d.shots('popular')
+>>> d.shots('everyone')
+>>> d.shots('debut')
+
+# Get shots for a player
+>>> d.shots('simplebits')
+>>> d.player('simplebits')
+
+# Get information on a particular shot
+>>> d.shot(1234)
+
+# See a particular shot's rebounds
+>>> d.rebounds(1234)
+
+# Get comments on a shot
+>>> d.comments(1234)
+
+# See the likes for a player
+>>> d.likes('simplebits')
+
+# Get the followers of a player
+>>> d.followers('simplebits')
+
+# See who a player is following
+>>> d.following('simplebits')
+>>> d.teammates('simplebits')
+
+# Get recent shots from the players a player is following
+>>> d.scoreboard('simplebits')
+
+# See who a given player has drafted
+>>> d.draftees('simplebits')
+
+# Get the Twitter username of a player
+>>> d.twitter('simplebits')
+
+# Check to see if a shot has attachments
+>>> d.attachments(1234)
+
+# See if a shot has PSD attachments
+>>> d.psd(1234)
+```
View
2  dribbble/__init__.py
@@ -1,2 +1,2 @@
from .api import *
-from .attachments import attachments, psds
+from .attached import attachments, psds
View
5 dribbble/api.py
@@ -97,6 +97,11 @@ def shots(kind=None, **params):
return get(url, **params)
+def teammates(name, **params):
+ """Same as following."""
+ return following(name, **params)
+
+
def twitter(name):
"""Return the Twitter username of a player."""
info = scout(name)
View
2  dribbble/attachments.py → dribbble/attached.py
@@ -19,7 +19,7 @@ def attachments(shot):
return links
-def psds(shot):
+def psd(shot):
"""Return PSD attachment links for a given shot."""
files = []
links = attachments(shot)
Please sign in to comment.
Something went wrong with that request. Please try again.