annotate README.txt @ 55:a5b7ea791f64

bzconsole/api.py
author Jeff Hammel <jhammel@mozilla.com>
date Thu, 19 Sep 2013 13:04:03 -0700
parents 3b7f4104cd72
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
22
3b7f4104cd72 add README + release
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
1 bzconsole
3b7f4104cd72 add README + release
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
2 =========
3b7f4104cd72 add README + release
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
3
3b7f4104cd72 add README + release
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
4 bzconsole is a simple python API to bugzilla's bzapi.
3b7f4104cd72 add README + release
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
5 Currently, it only has a few functions, including getting the
3b7f4104cd72 add README + release
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
6 configuration, listing the products and components, and filing a new
3b7f4104cd72 add README + release
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
7 bug. I mostly introduced it to make filing bugs from the command line
3b7f4104cd72 add README + release
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
8 simple. I'll probably include more features going forward as I need
3b7f4104cd72 add README + release
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
9 them, but if anyone else is interested I'm happy to take feature
3b7f4104cd72 add README + release
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
10 requests.
3b7f4104cd72 add README + release
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
11
3b7f4104cd72 add README + release
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
12 Usage
3b7f4104cd72 add README + release
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
13 -----
3b7f4104cd72 add README + release
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
14
3b7f4104cd72 add README + release
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
15 The console entry point is ``bz``. Invoking without options gives you
3b7f4104cd72 add README + release
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
16 the usage and help. The general pattern is
3b7f4104cd72 add README + release
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
17 ``bz [options] <command> [command-options]`` . Using ``bz help <command>``
3b7f4104cd72 add README + release
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
18 displays the help for the command.
3b7f4104cd72 add README + release
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
19
3b7f4104cd72 add README + release
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
20 You can have a ~/.bz dotfile to contain your username and password in.
3b7f4104cd72 add README + release
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
21
3b7f4104cd72 add README + release
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
22 Feel free to contact me with any questions!
3b7f4104cd72 add README + release
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
23
3b7f4104cd72 add README + release
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
24 jhammel@mozilla.com