cartman

cartman is an overweight, spoiled, immature, outspoken, lazy, foul-mouthed, mean-spirited, racist, sexist, anti-semitic, xenophobic, sociopathic, narcissistic, and ill-tempered elementary school student living with his mother. Wait... wrong cartman.

cartman allows you to create and manage your Trac tickets from the command-line, without the need to setup physical access to the Trac installation/database. All you need is a Trac account.

Configuration

At a minimum you need to create a ~/.cartmanrc file with the following:

[trac]
base_url = http://your.trac.install/
username = tamentis
password = sitnemat

If you are using vim as your default editor, you also might want to add email-like syntax highlighting to match the .cm.ticket extension:

autocmd BufNewFile *.cm.ticket setf mail

If you use multiple Trac sites, you can have multiple configurations in the same file using the section to separate the sites, here is an example:

[other]
base_url = http://other.trac.site/
username = tamentis
password = sitnemat

You would pass the -s parameter to cm to define which site to access:

cm -s other report 1

You may define all common configuration settings in the [DEFAULT] section.

Walkthrough

Report Listing

Dump a list of tickets on screen, without details:

cm report 1
#142. fix world hunger (bjanin@)
#159. ignore unpaid rent (bjanin@)

Ticket View

Show all the properties of a ticket:

cm view 1

List of Reports

Get a list of all the available reports with:

cm reports

System Properties

This will dump on screen all the Milestones, Components, Versions:

cm properties

Creating a ticket

Creating a ticket will work similarly to writing a new email in mutt, it loads your current $EDITOR and lets you edit the details of the ticket. Assuming all the parameters are correct, it will create the ticket as soon as you save and exit and return the ticket number. If your ticket does not appear valid (missing required field, inexistent Milestone, etc.) cartman will stop and lists each error and let you return to your editor:

cm new
-- opens your editor --

Found the following errors:
 - Invalid 'Subject': cannot be blank
 - Invalid 'Milestone': expected: Bug Bucket, Release 2, Release 3

-- Hit Enter to return to editor, ^C to abort --

The first parameter to cm is the owner of the ticket, it populates the To field by default:

cm new jcarmack

Commenting on a ticket

Just like creating a ticket, adding a comment is just like mutt, your current $EDITOR will be loaded on a blank file for you to edit. Upon save and exit, cartman will commit this new comment and return silently, unless an error occurs:

cm comment 1

If the comment is short enough to fit on the command line, you may use the -m flag as such:

cm comment 1 -m "you forgot to call twiddle()"

View/Set the status of a ticket

View the current status of a ticket, and the available statuses:

cm status 1

Set a ticket as accepted:

cm status 1 accept

If you need to add a comment with this status change, you can use the -c flag, it will open your default editor:

cm status 1 reopen -c

You may also use the -m flag to define the comment inline, without the use of an editor:

cm status 1 reopen -m "does not work with x = y"

What is new in this release:

• added search command.
• crash properly and early when trac return error 500.
• crash with a descriptive message when you lack permission to create a ticket.
• don't die if the base_url has a trailing slash.
• test the existence of base_url instead of stack tracing.
• create the ~/.cartman/ directory by default.
• die with an error message if you don't have an $EDITOR env var.
• fix fetching current ticket status on v1.0+

What is new in version 0.2.0:

• "cm help" now prints a list of commands.
• auth_type was added to the config.
• Basic Debian packaging was added.
• Template support was added (in ~/.cartman/templates).
• A document on how to hack the tools was provided.
• Configuration was moved to a sub-directory.
• An option to skip SSL certificate validation was added.
• Support for Trac 0.12 was added.
• Single tokens are now matched during fuzzy find.
• Python 3.3 support was added.
• Ticket bodies are now transmitted with CRLF end of lines.

Requirements:

• Python
• Trac