opendev
/
python-storyboardclient
Code Issues Proposed changes
Python Client library for StoryBoard
55 Commits 1 Branch 2 Tags 657 KiB
Python 99.9%
reStructuredText 0.1%
Go to file
Zara 9a21d1fa0e Give user option to bypass verification 
This allows a user to use the python client with a storyboard
instance that has a self-signed certificate, such as
https://storyboard-dev.openstack.org

Change-Id: Id1b1fb7b1b3921b70b2fa6946f13d188dd88f64e
 		2016-09-06 16:02:54 +00:00
doc/source It's 2016 2016-09-05 12:20:00 +02:00
storyboardclient Give user option to bypass verification 2016-09-06 16:02:54 +00:00
tools Adding pretty-tox 2015-01-27 16:37:07 +03:00
.coveragerc Change ignore-errors to ignore_errors 2015-09-21 14:23:56 +00:00
.gitignore Initial Cookiecutter Commit. 2014-12-04 17:10:28 +03:00
.gitreview Added .gitreview 2014-12-01 09:51:21 +00:00
.mailmap Initial Cookiecutter Commit. 2014-12-04 17:10:28 +03:00
.testr.conf Setting up base classes 2014-12-22 16:36:08 +03:00
CONTRIBUTING.rst Initial Cookiecutter Commit. 2014-12-04 17:10:28 +03:00
HACKING.rst Initial Cookiecutter Commit. 2014-12-04 17:10:28 +03:00
LICENSE Initial Cookiecutter Commit. 2014-12-04 17:10:28 +03:00
MANIFEST.in Initial Cookiecutter Commit. 2014-12-04 17:10:28 +03:00
README.rst Add basic docs for python client 2016-09-02 11:18:56 +00:00
babel.cfg Initial Cookiecutter Commit. 2014-12-04 17:10:28 +03:00
openstack-common.conf Added required dependencies 2014-12-17 13:27:07 +03:00
requirements.txt Setting up base classes 2014-12-22 16:36:08 +03:00
setup.cfg Initial Cookiecutter Commit. 2014-12-04 17:10:28 +03:00
setup.py Initial Cookiecutter Commit. 2014-12-04 17:10:28 +03:00
test-requirements.txt Remove discover from test-requirements 2016-07-22 04:59:37 +00:00
tox.ini Removed py33, pypy from python-storyboardclient 2015-02-18 15:56:20 -08:00

README.rst

python-storyboardclient

Python Client library for StoryBoard

Features

  • TODO

Notes

This is the StoryBoard python client! It lets you interact with StoryBoard from the comfort of your own terminal! There is no command to run this; instead you can import it into scripts. This lets you perform complex actions on things in StoryBoard, eg: add an helpful comment on all stories with 'cannot store contact information' in the description, pointing users at the relevant docs, but only if there is no comment to this effect already. (There is an example of such a script in usage)

Some sample commands are given in usage.rst. In general, most resources (ie: stories, tasks, projects, and so on) have a get_all() and get() method. The latter takes the resource's id as a parameter, thought it can also take other attributes (eg: tag name).

To create a new resource, use the create() method. The necessary parameters depend on the resource, and if not documented, can be worked out from the relevant .py file in the code for the StoryBoard API.

The update() method will update mutable fields of the resource (again, these vary depending on the resource).

Finally, delete() will delete things.

Happy task-tracking!