diff options
Diffstat (limited to 'doc/source/sdk.rst')
| -rw-r--r-- | doc/source/sdk.rst | 48 |
1 files changed, 48 insertions, 0 deletions
diff --git a/doc/source/sdk.rst b/doc/source/sdk.rst new file mode 100644 index 0000000..aa15250 --- /dev/null +++ b/doc/source/sdk.rst @@ -0,0 +1,48 @@ +=== +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 +
\ No newline at end of file |