diff --git a/README.rst b/README.rst index 0fda07b..09b2a68 100644 --- a/README.rst +++ b/README.rst @@ -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 - [, ...] - - 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 + [, ...] + + >>> convore.groups['api-2'] + + + >>> convore.groups['api-2'].leave() + True + + >>> convore.groups.create(name, description=None, slug=None) + + + >>> convore.groups['api-2'].topics + [, ...] + + >>> convore.groups['api-2'].topics.create(name) + + + >>> convore.groups.['api-2'].topics[topic_id].messages + [, ...] + + >>> 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 ----------