make api more pythonic, add __doc__ to functions

This commit is contained in:
j 2010-12-04 15:14:54 +01:00
commit 1ac0604b9f
2 changed files with 37 additions and 21 deletions

23
README
View file

@ -24,15 +24,16 @@ pandora client example:
just using the API:
api = pandora_client.API("http://localhost:8000/api/")
r = api.find({
'query': {'conditions':[]},
'keys': ['title', 'year'],
'range': [0, 100]
})
for i in r['data']['items']:
...
api features and documentation is available at the api end point,
i.e. http://localhost:8000/api/
api = pandora_client.API("http://localhost:8000/api/")
r = api.find(
query={'conditions':[]},
keys=['title', 'year'],
range=[0, 100]
)
for i in r['data']['items']:
...
forther api documentation is available as python docstrings.
api.find?
and there is a web api documentation at i.e. http://localhost:8000/api/