From d7622a8f0a44af0076f5a1c7e252d622ba9d6f35 Mon Sep 17 00:00:00 2001 From: Zara Date: Mon, 19 Sep 2016 12:34:25 +0000 Subject: [PATCH] Update 'usage' This updates the commentary on the python client, now that it can work with StoryBoard instances that use self-signed certificates. It also removes 'examples of delete commands' from the TODOs, as we don't want to make it easy for passers-by to copy-paste a command to delete data in bulk without any understanding. Change-Id: Icb9660ac79992a1e53baa89f1016c626b0cfe467 --- doc/source/usage.rst | 16 +++++++++++----- 1 file changed, 11 insertions(+), 5 deletions(-) diff --git a/doc/source/usage.rst b/doc/source/usage.rst index 85499fb..af27943 100644 --- a/doc/source/usage.rst +++ b/doc/source/usage.rst @@ -9,11 +9,20 @@ To use python-storyboardclient in a project:: access_token="$MY_ACCESS_TOKEN" storyboard = client.Client(api_url, access_token) -That will not work with storyboard-dev at the moment, as storyboard-dev -uses a self-signed certificate-- but it demos the syntax. It is very + +The access token is optional, but needed for creating things, +updating things, or retrieving private information. It is very important to use https, not http, or you will get weird and wonderful errors! +The 'verify' setting is necessary for accessing instances using +self-signed certificates (including storyboard-dev). So, for such +instances, you would need to adjust the above example to include:: + + verify = False + storyboard = client.Client(api_url, access_token, verify) + + Some sample commands to get things:: get_stories = storyboard.stories.get_all() @@ -93,10 +102,7 @@ Longer sample script:: except: pass - TODO: -Some examples of `delete` commands Sections on updating board and worklist items need filling in. Timeline events for boards and worklists need adding. -