Improve Python Client Guide Quality - for app developers

Registered by Tom Fifield on 2013-11-25

The python-*client packages are the closest thing OpenStack has to python language bindings/python SDK. They provide much functionality, but using them to achieve the goals of an application developer working with python, building an application on top of an OpenStack cloud, is currently thwarted by poor documentation. This blueprint is aimed at improving the quality of this documentation to the point where app developers can happily use it in their day-to-day interactions with OpenStack Clouds.

Blueprint information

Status:
Complete
Approver:
Tom Fifield
Priority:
Essential
Drafter:
Tom Fifield
Direction:
Approved
Assignee:
Lorin Hochstein
Definition:
Approved
Series goal:
Accepted for juno
Implementation:
Implemented
Milestone target:
milestone icon juno
Started by
Tom Fifield on 2014-10-08
Completed by
Tom Fifield on 2014-10-08

Related branches

Sprints

Whiteboard

Tom, I think we added the Python SDK chapter to the User Guide in hopes of alleviating some of this difficulty. http://docs.openstack.org/user-guide/content/ch_sdk.html

To maintain docs across python-*client is not sustainable, and the bigger picture is to document the common openstack client and common SDKs. Let's discuss further before approving this blueprint. To me, the work items are not improving the existing sites but finding commonality and improvements for developer.openstack.org.

Existing sites:
- http://docs.openstack.org/developer/python-keystoneclient/
- http://docs.openstack.org/developer/python-novaclient/
- http://docs.openstack.org/developer/python-glanceclient/
- http://docs.openstack.org/developer/python-cinderclient/
- http://docs.openstack.org/developer/python-neutronclient/
- http://docs.openstack.org/developer/python-swiftclient/
- http://docs.openstack.org/developer/python-heatclient/
- http://docs.openstack.org/developer/python-ceilometerclient/

(?)

Work Items

Work items:
Come up with consistent structure: TODO
Implement that across each project: TODO
Worked example for each Python binding call: TODO

This blueprint contains Public information 
Everyone can see this information.