Exporting and Archiving Issues

To keep the public (who may not have access to PyDitz) apprised of the current status of your project, you can export the database. To do an export, you use the export command followed by the name of the format you want to export. By default, it writes the exported files into a directory with the same name as the export format. If you give an extra pathname argument, it’ll use that instead.

Typing help export will list the available export formats:

Ditz: help export
Command:
   export -- Export issue database

Usage:
   export FORMAT [PATH]
   export --list

Arguments:
   FORMAT   Export format
   PATH     Path to export to

Options:
   -l, --list     List the available export formats

Here’s an example of exporting to HTML:

Ditz: export html .ditz-html
Exported issues to '.ditz-html'

Note

The original ditz program only offered one export format: HTML. As a result, its command to produce HTML was just called html. If you want compatibility with the original, you can create a command alias in your Configuration File to do that. Just add html = export html to the [alias] section.

For an example of the HTML output itself, see the output from PyDitz’s issue tracker. The only thing that may not be obvious when browsing the HTML is that you can click on table headers, which sorts the table on that field. Clicking again reverses the sort order.

New in version 0.9: HTML markup.

If you have installed the Markups module, PyDitz will use that to convert recognized markup in the issue text to the corresponding HTML (bold, italic, links, etc). The default markup is markdown, but you can change that by setting html_markup in the [export] section of your Configuration File to one of the supported markups: markdown, restructuredtext or textile. (If you want different markup for different projects, you can do that using per-project config files.)

If the pathname argument to the export command looks like the name of a file archive (e.g., issues.zip, or issues.tar.gz), the output directory is bundled into the archive of that name and removed.

When you decide that a previously-released release and its issues is no longer useful to keep around in your issue database, you can archive it using the archive command. This moves all issues from that release to an archive directory. If not specified, it is ditz-archive-<num> where, <num> is the release number.

Ditz: archive 1.0 .ditz-archive-1.0
Archived to .ditz-archive-1.0