opendev/python-storyboardclient
Code Issues Proposed changes
Python Client library for StoryBoard
63 Commits 1 Branch 2 Tags 657 KiB
Python 99.9%
reStructuredText 0.1%
b9bdddde51
Go to file
Doug Hellmann b9bdddde51 remove or adopt incubated oslo code 
Switch to oslo.i18n fully.

Move the old incubated apiclient package to storyboardclient._apiclient
to make it clear it is no longer maintained by the Oslo team.

Remove the configuration file for syncing from the Oslo incubator.

Update the flake8 and coverage settings to ignore the apiclient in its
new home until it is cleaned up and passes completely.

Story: 2000776
Change-Id: I017e965353a20e0af151f0db9dc0ea8da9ff4b2f
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
2016-11-08 13:44:49 -05:00
doc/source Update 'usage' 2016-09-23 17:58:57 +00:00
storyboardclient remove or adopt incubated oslo code 2016-11-08 13:44:49 -05:00
tools Adding pretty-tox 2015-01-27 16:37:07 +03:00
.coveragerc remove or adopt incubated oslo code 2016-11-08 13:44:49 -05: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
babel.cfg Initial Cookiecutter Commit. 2014-12-04 17:10:28 +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
requirements.txt remove or adopt incubated oslo code 2016-11-08 13:44:49 -05: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 remove or adopt incubated oslo code 2016-11-08 13:44:49 -05: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!