opendev
/
python-storyboardclient
Code Issues Proposed changes
Python Client library for StoryBoard
74 Commits 1 Branch 2 Tags 657 KiB
Python 99.9%
reStructuredText 0.1%
Go to file
Doug Hellmann e8b3de622c build universal wheels 
We support Python 2 and 3 and don't have any C source that needs to be
compiled when building the wheel, so go ahead and build universal
wheels.

Change-Id: Ic2b4ae5e29e3fd870642bf7e4e4b7287267857c4
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
 		2018-02-16 15:19:15 -05:00
doc update documentation build for new PTI 2018-01-12 16:06:57 -05:00
storyboardclient use six to make iteritems python 2/3 compatible 2018-01-24 17:20:36 -05:00
.coveragerc remove or adopt incubated oslo code 2016-11-08 13:44:49 -05:00
.gitignore ignore .stestr output directory 2018-01-24 17:20:28 -05: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 fix formatting of contributing file 2018-01-12 16:07:01 -05: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
requirements.txt remove or adopt incubated oslo code 2016-11-08 13:44:49 -05:00
setup.cfg build universal wheels 2018-02-16 15:19:15 -05:00
setup.py Initial Cookiecutter Commit. 2014-12-04 17:10:28 +03:00
test-requirements.txt update documentation build for new PTI 2018-01-12 16:06:57 -05:00
tox.ini Merge "change default python 3 env in tox to 3.5" 2018-02-11 15:30:28 +00: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!