Package: bugzillatools
bugzillatools consists of thebugzillaCLI program and a Python
library for interacting with theBugzillabug tracking system, and
plugins for version control systems that enable interaction with
Bugzilla installations.The only dependency isPython2.7 and bugzillatools works withBugzilla4.0 or later where the XML-RPC feature is enabled.Installation# via pip
pip install bugzillatools         # as superuser
  -or-
pip install bugzillatools --user  # user site-packages installation

# from source
python setup.py install           # as superuser
  -or-
python setup.py install --user    # user site-packages installationThebin/directory in your user base directory will need to appear
on thePATHif installing to user site-packages.  This directory is
system dependent; seePEP 370.If installing to user site-packages, some manual moving or symlinking
of files will be required for the Bazaar plugin to be detected by
Bazaar.PEP 402speaks to this shortcoming.ComponentsbugzillaprogramCommand-line application for interacting with Bugzilla servers.
The following subcommands are available:assign:Assign bugs to the given user.block:Show or update block list of given bugs.cc:Show or update CC List.comment:List comments or file a comment on the given bugs.config:Show or update configuration.depend:Show or update dependencies of given bugs.desc:Show the description of the given bug(s).dump:Print internal representation of bug data.edit:Edit the given bugs.fields:List valid values for bug fields.help:Show help.history:Show the history of the given bugs.info:Show detailed information about the given bugs.list:Show a one-line summary of the given bugs.new:File a new bug.priority:Set the priority on the given bugs.products:List the products of a Bugzilla instance.search:Search for bugs matching given criteria.status:Set the status of the given bugs.time:Show or adjust times and estimates for the given bugs.bzlibLibrary providing access to Bugzilla instances through the XML-RPC
interface.  Supports bug creation, bug information and comment
retrieval, updating bug fields and appending comments to bugs.BazaarpluginThis plugin, when enabled for Bugzilla bugtrackers, marks bugs fixed on
those trackers whenbzr commitis invoked with the--fixesargument.
It also adds a comment to the bug that includes the branch location, the
commit message, the list of changed files and other details about the commit.TheBazaarplugin requires Bazaar 2.0 or later.Configuration.bugzillarcThebugzillaprogram looks for its configuration in~/.bugzillarc, which uses ini-style configuration.coreserverName of the default serveraliasOption names are aliases; their values are the replacement.server.<name>Define a server.  bugzillatools supports multiple servers; the--server=<name>argument can be used to select a server.urlBase URL of the Bugzilla server (mandatory)userBugzilla username (optional)passwordBugzilla password (optional)assign_statusWhen theassigncommand is used, if the current status of a bug
is in the first list, the status will be updated to the second item.
The format is:<oldstatus>[,<oldstatus>]*<newstatus>.  An
appropriate value for the default Bugzilla workflow might be:"UNCONFIRMED,CONFIRMED IN_PROGRESS".default_productIf provided and if the provided string corresponds to the name of a
product on this server, use that product as the default.  The user
will still be prompted to confirm.Example.bugzillarc[core]
server = example

[server.example]
url = http://bugzilla.example.com
user = user@example.com
password = sekrit

[alias]
fix = status --status RESOLVED --resolution FIXED
wfm = status --status RESOLVED --resolution WORKSFORME
confirm = status --status CONFIRMEDBazaar pluginTo enable the Bazaar bugzillatools plugin, include following
configuration directives in either~/.bazaar/bazaar.conf(global
configuration) or.bzr/branch/branch.conf(within a branch):bugzilla_<server>_bugzillatools_enable = True
bugzilla_<server>_url = <bugzilla url>
bugzilla_<server>_status = RESOLVED
bugzilla_<server>_resolution = FIXEDSuch a configuration assumes that a section[server.<server>]has been defined in your.bugzillarc.You can now set the status of bugs (using the status and resolution
defined in the Bazaar config) directly:bzr commit -m 'fix bug 123' --fixes <server>:123Licensebugzillatools is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.ContributingThe bugzillatools source code is available fromhttps://github.com/frasertweedale/bugzillatools.Bug reports, patches, feature requests, code review and
documentation are welcomed.To submit a patch, please usegitsend-emailor generate a pull
request.  Write awell formed commit message.  If your patch is
nontrivial, update the copyright notice at the top of each changed
file.Changelogv0.5.5 :: Sat Apr 25 2015New features:commentcommand learned the--privateoption
(contributed by Johannes Segitz)Bug fixes:fix comment enumeration orderfix string encoding error when invoking editor which could lead to invalid
XML being sent to serverv0.5.4 :: Sun Nov 23 2014Bug fixes:better error messages on missing server/account configuration (#3)remove fields without name data from bug records (#5)make user and password configuration optional (#12)v0.5.3.1 :: Sun Nov 24 2013Bug fixes:fix installation errorv0.5.3 :: Sat Nov 23 2013Bug fixes:editor: fix incorrect path to vi(1) when EDITOR is not defined
(issues/1; reported by @taa1)createcommand: treat “defaulted” fields as mandatory in case
no default is set (issues/2; reported by @taa1)ui: fix some unicode encoding errorsfieldscommand: handle minor changes in result format in 4.4correct the name of the platform field (platform -> rep_platform)Other changes:expand bzr plugin documentationv0.5.2 :: Tue Feb 7 2012New features:prioritycommand: set the priority of the given bugs.commentcommand learned the--whichargument, for limiting
output to only the given comment(s).searchlearned the--versionargument.editcommand: edit the product version of a bug.Bug fixes:searchcommand: fix crash when zero bugs returnedOther changes:-Vreplaces--versionfor displaying program version
information.v0.5.1 :: Tue Jan 10 2012Bug fixes:newcommand: fix assigned_to user matching.v0.5 :: Tue Jan 3 2012New features:searchcommand: search for bugs matching given criteria.historycommand: display bug history.newcommand: new configserver.<name>.default_product, if set
and if corresponding to a product on the server, specifies the default
product.newcommand: perform user matching when specifying the assignee or
cc list during bug creation.Bug fixes:timecommand: calculate the hours worked on a bug.v0.4 :: Wed Nov 30 2011New features:timecommand: show or adjust times and estimates for given bug.
At time of writing, limitations in Bugzilla’s RPC API prevent the
display of cumulative time for a bug.desccommand: show the description of the given bugs.dumpcommand: print internal representation of bug(s).commentlearned the--omit-emptyand--include-emptyarguments; exclude or include empty comments (e.g. additional time
worked, but no specific comment) from the output.  The default is to
omit empty comments.Theassigncommand can now be configured (on a per-server basis)
to change the status of a bug, using theassign_statusoption.
See README for details.Bug fixes:Bugzilla URLs are now more rigourously sanity checked.Other changes:Configuration file syntax changed to ini-like (i.e., parsable byConfigParser).  JSON configuration is no longer supported.v0.3 :: Sun Aug 7 2011New features:Added the Bazaar plugin.newcommand: file a new bug, prompting user for bug data.statuslearned the--dupe-ofargument; this is all that’s needed
to mark a bug as a duplicate of another (Bugzilla with automatically set
the status and resolution fields to appropriate values).Bug fixes:statusonly prompts for resolution if new status is closed and
current status is open (--resolutionmay still be specified,
however.)The unused--choose-statusand--choose-resolutionarguments
were removed fromstatus.Fix the index-field width when displaying choose-from lists (was too
wide when the number of items displayed was a power of 10)ConvertEOFError(^D) intobzlib.ui.RejectWarningwhen
prompting user for input.Don’t bother prompting the user to choose an item from a list that
contains only one item.v0.2.1 :: Tue Jul 12 2011Bug fixes:Support Unicode data in all commands.Do not show ‘aliases’ heading in--helpoutput if none defined.Add global arguments to subcommand--helpoutput.v0.2 :: Sat Jul 2 2011New features:commentnow lists bug comments when no comment is given.--forward,--reverseand--limit=Ncan be used to control
output.dependandblockcommands: show or update bug dependency
relationships.cccommand: Show or update CC List.fieldscommand: List valid values for bug fields.helpcommand: Show help for a command, or the top-level help if
no argument is given.--versionprints bugzillatools version.Invoke EDITOR for comment input when comment required but not
explicitly providedUser matching:  For commands that require usernames, instead of
providing full username, if a provided fragment matches a single user
that user will be used.Command aliases: users can define their own aliases for commands and
command arguments.Replaceclose,fix,reopenandresolvecommands with the
singlestatuscommand; commands to suit a particular workflow can be
defined as aliases ofstatus, with appropriate arguments.Bug fixes:Improved server misconfiguration or missing configuration handling.List commands in alphabetical order.Other changes:The default user configuration file changed to~/.bugzillarc(formerly ~/.bugrc).v0.1.2 :: Fri Jun 17 2011Bug fixes:Fix Bugzilla construction argsv0.1.1 :: Tue Jun 14 2011New features:productscommand: list products of a Bugzilla.Describe subcommands in--helpoutput.Bug fixes:Handle server lookup failure when no servers are defined.v0.1 :: Sun Jun 12 2011New features:First release of bugzillatools