Files
python-swiftclient/doc/source/sdk.rst
Alexandra f82d26063a New python swiftclient doc
Updating with new ToC to be worked on at hackathon

Change-Id: I55ee83626dd88fcc3e6352b3854b758dd7090590
2016-02-10 18:33:34 +10:00

48 lines
700 B
ReStructuredText

===
SDK
===
Where to start?
~~~~~~~~~~~~~~~
.. TODO
when to use SwiftService
when to use client.py
SwiftService classes and methods
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. TODO
docs for each method (autogen from docstrings?)
Client classes and methods
~~~~~~~~~~~~~~~~~~~~~~~~~~
.. TODO
docs for each method (autogen from docstrings?)
Guidelines for writing an app
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. TODO
auth
how to use various features
when to use various features
pooling connections
concurrency
retries
Prescriptive examples
~~~~~~~~~~~~~~~~~~~~~
.. TODO
A "Hello World" example
connecting
uploading an object
uploading a directory