kennethreitz-archive/python-convore
1
0
Fork 0
mirror of https://github.com/kennethreitz-archive/python-convore.git synced 2026-06-05 23:40:18 +00:00
Code Issues Packages Projects Releases Wiki Activity

api style established

Browse Source
This commit is contained in:
Kenneth Reitz
2011-02-14 03:18:34 -05:00
parent 11e558c0d0
commit 5f6d2861e8
1 changed files with 46 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.rst
+46 -22
View File
@@ -3,35 +3,59 @@ Convore: Python API Wrapper
::
.d8888b .d88b. 88888b. 888 888 .d88b. 888d888 .d88b.
d88P" d88""88b 888 "88b 888 888 d88""88b 888P" d8P Y8b
888 888 888 888 888 Y88 88P 888 888 888 88888888
Y88b. Y88..88P 888 888 Y8bd8P Y88..88P 888 Y8b.
"Y8888P "Y88P" 888 888 Y88P "Y88P" 888 "Y8888
.d8888b .d88b. 88888b. 888 888 .d88b. 888d888 .d88b.
d88P" d88""88b 888 "88b 888 888 d88""88b 888P" d8P Y8b
888 888 888 888 888 Y88 88P 888 888 888 88888888
Y88b. Y88..88P 888 888 Y8bd8P Y88..88P 888 Y8b.
"Y8888P "Y88P" 888 888 Y88P "Y88P" 888 "Y8888
Overview
--------
This is going to be awesome, and modeled after the excellent github2 module.
This is going to be awesome, and modeled after the excellent github2 module.
Usage
-----
Hmm.. ::
>>> from convore import Convore
>>> convore = Convore('username', 'password')
>>> convore.groups
[<group id='123'>, ...]
convore.groups[id] ?
convore.groups.create(name, decription=None, slug=None)
>>> from convore import Convore
>>> convore = Convore('username', 'password')
>>> convore.account.verify()
True
>>> convore.groups
[<group 'api-2'>, ...]
>>> convore.groups['api-2']
<group 'api-2>
>>> convore.groups['api-2'].leave()
True
>>> convore.groups.create(name, description=None, slug=None)
<group 'group-name'>
>>> convore.groups['api-2'].topics
[<topic 'group/topic-name'>, ...]
>>> convore.groups['api-2'].topics.create(name)
<topic 'group/topic-name>
>>> convore.groups.['api-2'].topics[topic_id].messages
[<message 'group/topic/'>, ...]
>>> convore.groups.['api-2'].topics[topic_id].messages.create(message)
True
convore.groups.create(name, decription=None, slug=None)
Installation
@@ -39,14 +63,14 @@ Installation
To install tablib, simply: ::
$ pip install convore
$ pip install convore
Or, if you absolutely must: ::
$ easy_install convore
$ easy_install convore
But, you really shouldn't do that.
Contribute
----------