af25ae6e07
The :doc: role is only known to Sphinx, so when we publish the README.rst to PyPI and include that role it causes the content to not render as proper HTML. This patch removes some of the content from the readme and moves it to the main index page for the documentation. It then removes the readme.rst file from the doc build because we don't need to include the same content multiple times. Change-Id: Ic46c7a9d8e91f01b5e6cef5d377a56856b586c70 Signed-off-by: Doug Hellmann <doug@doughellmann.com>
1.4 KiB
python-storyboardclient
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. 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!
Contents:
installation usage contributing
Indices and tables
genindexsearch