tratihubis 0.5

Installation

To install tratihubis, use pip or easy_install:

$ pip install tratihubis

If necessary, this also installs the PyGithub package.

Usage

Information about Trac tickets to convert has to be provided in a CSV file. To obtain this CSV file, create a new Trac queries using the SQL statement stored in query_tickets.sql and query_comments.sql. Then execute the queries and save the results by clicking “Download in other formats: Comma-delimited Text” and choosing for example /Users/me/mytool/tickets.csv and /Users/me/mytool/comments.csv as output files.

Next create a config file to describe how to login to Github and what to convert. For example, you could store the following in ~/mytool/tratihubis.cfg:

[tratihubis]
user = someone
password = secret
repo = mytool
tickets = /Users/me/mytool/tickets.csv
comments = /Users/me/mytool/comments.csv

Then run:

$ tratihubis ~/mytool/tratihubis.cfg

This tests that the input data and Github information is valid and writes a log to the console describing which operations would be performed.

To actually create the Github issues, you need to enable to command line option --really:

$ tratihubis --really ~/mytool/tratihubis.cfg

Be aware that Github issues and milestones cannot be deleted in case you mess up. Your only remedy is to remove the whole repository and start anew. So make sure that tratihubis does what you want before you enable --really.

users = johndoe: jdoe78, *: me

users = *:*

labels = type=defect: bug, type=enhancement: enhancement, resolution=wontfix: wontfix

labels = type="software defect": bug

Limitations

The author of Github issues and comments always is the user specified in the config, even if a different user opened the original Trac ticket or wrote the original Trac comment.

Github issues and comments have the current time as time stamp instead if time from Trac.

Github issue descriptions contains the raw Trac Wiki markup, there is no translation to Github markdown.

The due date of Trac milestones is not migrated to Github milestones, so when the conversion is done, you have to set it manually.

Trac Milestone without any tickets are not converted to Github milestone.

Support

In case of questions and problems, open an issue at <https://github.com/roskakori/tratihubis/issues>.

To obtain the source code or create your own fork to implement fixes or improvements, visit <https://github.com/roskakori/tratihubis>.

License

Copyright (c) 2012-2013, Thomas Aglassinger. All rights reserved. Distributed under the BSD License.

Changes

Version 0.5, 2013-02-13

(Contributed by Steven Di Rocco)

• Added support for file attachments.

• Added work around for information lost due GitHub API limitations: * Added trac commenter and date at the top of each comment. * Added automatic comment to each isseu showing original author, date authored, and last modification date.

• Fixed API calls to work with PyGithub 1.8.

Version 0.4, 2012-05-04

• Added config option labels to map Trac status and resolution to Github labels.

Version 0.3, 2012-05-03

• Added config option comments to convert Trac ticket comments.

• Added closing of issue for which the corresponding Trac ticket has been closed already.

• Added validation of users issues are assigned to. They must have an active Github user.

Version 0.2, 2012-05-02

• Added config option users to map Trac users to Github users.

• Added binary in order to run tratihubis instead of python -m tratihubis.

• Changed supposed issue number in log to take existing issues in account.

Version 0.1, 2012-05-01

• Initial release.