rackerlabs / rore

A command line tool for working with Redmine

Build Status

rore

A command line tool for working with Redmine

Requires a config file like:

[default]
url=https://redmine.yourorg.tld
key=7c6cnotarealkey2b198c24449cca20b61c95854
verify=1

The key required is your API key. You can find your API key on your account page ( /my/account ) when logged in, on the right-hand pane of the default layout. The verify option dictates whether to validate the certificate (Default is False if not present)

The config file should be located at ~/.rore.

Uses python-redmine

INSTALLATION

$ pip install rore

Or to install directly from checkout:

$ python setup.py build
$ python setup.py install

USAGE

$ rore issues --query

$ rore issues --create --project deploy --subject 'Deploy broken!'

$ rore projects --list

DOCUMENTATION

Nothing exists right now except for the help output.

$ rore --help

$ rore issues --help

TESTING

tox -r

CONTRIBUTING

License is Apache 2.0.

Pull requests welcome.

Find me in #rackspace-dev on Freenode as jmeridth

CREATED BY

Jesse Keating @iamjkeating jlk on freenode/irc

rore's Issues

Add flag to return related tasks when listing a specific task

Much like subtasks.

Add ability to change tracker type

Add a usage output if no args are sent to a subcommand

Add custom field output to verbose issue printing

This may require some upstream work on pyredminews to be able to better access custom field data.

issue printing of relations needs to use context in output

Just reading the relation data may put the context wrong when printing out. It can print the relationship direction wrong, so make use of blocked/blocks data to orient the relation to the issue being printed.

Don't use "issues" as a variable name

issues is a function, overloading it can be weird.

Add ability to change project assignment

Add flag to return subtasks when listing a specific task

Should be pretty simple, but will need some sort of output heading to indicate subtasks.

Add option to see tracker types for a project

I think each project can have its own tracker type, so we need to be able to list those out and help people figure out what they can set for an issue.

Add ability to assign / change a user to an issue

issue printing of relations needs to use context in output

The relation direction needs to be tweaked based on which issue is being printed at the moment.

Add ability to re-order child tasks

it'd take in a series of IDs
ID[0] is the parent, and everything else is the order the children should be
it should fail if you cite an ID that is not already a child

by default it is the order they were attached to the parent
so if you come up with an task that is really meant to be earlier in the list you have to:
disassociate everything after the new task from the parent
add the new task
add everything back
to get them in order

redmine works out the order based on 'lft' and 'rgt' (left and right) fields in the issues table in the database. I think the arrangement is parent.lft < child.lft < child.rgt < parent.rgt, and sibA.lft < sibB.lft == sibA.rgt < sibB.rgt. This seems to be what the "awesome_nested_set" plugin deals with... It in turn provides some functions like node.move_to_right_of(other) which should fix up the lft/rgt values appropriately so that 'node' comes immediately after 'other'. I can't see anywhere in redmine that that functionality is actually exposed though. I presume it could be added in a plugin... Doing the 'remove parent, add parent' thing to move the issue to being the last child works, except it also adds irritating notes in the history of each issue modified.

Handle unauthorized issues

Ran across an issue I wasn't authorized to see, when trying to print a relationship. Handle it there and in print_issue.

Ability to delete relationship

We can haz it?

Add ability to discover project details by name and identifier

Write our own API

pyredminews just isn't going to cut it, so write our own.

Output of “rore issues --close” isn't refreshed

When closing an issue with rore issues --close <ID>, the output shows the issue in its previous state (i.e. not "closed"). The operation is successful, however.

For example:

~ $ rore issues --close 1483
1483 ( https://redmine.ohthree.com/issues/1483 )
subject:     demo
type:        Epic
assigned to: UNASSIGNED
project:     Deployments
status:      New
completion:  0

~ $

Add verbose flag for printing tickets

This should print out all the available fields.

Add ability to list out projects

Useful for being able to tell what project an issue should be assigned to.

Will likely be a new top level subcommand

Figure out a way to validate whether an issue status can be set via workflow

Workflow settings can dictate whether a status can be set, this should be validated and reported back to the user if they try to do something not allowed.

Add ability to close or resolve an issue

Should validate the status somehow.