File: features.html

package info (click to toggle)
roundup 1.2.1-10%2Betch1
links: PTS
area: main
in suites: etch
size: 4,764 kB
ctags: 3,756
sloc: python: 30,296; sh: 1,497; perl: 23; makefile: 22
file content (419 lines) | stat: -rw-r--r-- 12,045 bytes
parent folder | download | duplicates (2)
<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="Docutils 0.4: http://docutils.sourceforge.net/" />
<title>Roundup Features</title>
<style type="text/css">

/*
:Author: David Goodger
:Contact: goodger@users.sourceforge.net
:Date: $Date$
:Revision: $Revision$
:Copyright: This stylesheet has been placed in the public domain.

Default cascading style sheet for the HTML output of Docutils.

See http://docutils.sf.net/docs/howto/html-stylesheets.html for how to
customize this style sheet.
*/

/* used to remove borders from tables and images */
.borderless, table.borderless td, table.borderless th {
  border: 0 }

table.borderless td, table.borderless th {
  /* Override padding for "table.docutils td" with "! important".
     The right padding separates the table cells. */
  padding: 0 0.5em 0 0 ! important }

.first {
  /* Override more specific margin styles with "! important". */
  margin-top: 0 ! important }

.last, .with-subtitle {
  margin-bottom: 0 ! important }

.hidden {
  display: none }

a.toc-backref {
  text-decoration: none ;
  color: black }

blockquote.epigraph {
  margin: 2em 5em ; }

dl.docutils dd {
  margin-bottom: 0.5em }

/* Uncomment (and remove this text!) to get bold-faced definition list terms
dl.docutils dt {
  font-weight: bold }
*/

div.abstract {
  margin: 2em 5em }

div.abstract p.topic-title {
  font-weight: bold ;
  text-align: center }

div.admonition, div.attention, div.caution, div.danger, div.error,
div.hint, div.important, div.note, div.tip, div.warning {
  margin: 2em ;
  border: medium outset ;
  padding: 1em }

div.admonition p.admonition-title, div.hint p.admonition-title,
div.important p.admonition-title, div.note p.admonition-title,
div.tip p.admonition-title {
  font-weight: bold ;
  font-family: sans-serif }

div.attention p.admonition-title, div.caution p.admonition-title,
div.danger p.admonition-title, div.error p.admonition-title,
div.warning p.admonition-title {
  color: red ;
  font-weight: bold ;
  font-family: sans-serif }

/* Uncomment (and remove this text!) to get reduced vertical space in
   compound paragraphs.
div.compound .compound-first, div.compound .compound-middle {
  margin-bottom: 0.5em }

div.compound .compound-last, div.compound .compound-middle {
  margin-top: 0.5em }
*/

div.dedication {
  margin: 2em 5em ;
  text-align: center ;
  font-style: italic }

div.dedication p.topic-title {
  font-weight: bold ;
  font-style: normal }

div.figure {
  margin-left: 2em ;
  margin-right: 2em }

div.footer, div.header {
  clear: both;
  font-size: smaller }

div.line-block {
  display: block ;
  margin-top: 1em ;
  margin-bottom: 1em }

div.line-block div.line-block {
  margin-top: 0 ;
  margin-bottom: 0 ;
  margin-left: 1.5em }

div.sidebar {
  margin-left: 1em ;
  border: medium outset ;
  padding: 1em ;
  background-color: #ffffee ;
  width: 40% ;
  float: right ;
  clear: right }

div.sidebar p.rubric {
  font-family: sans-serif ;
  font-size: medium }

div.system-messages {
  margin: 5em }

div.system-messages h1 {
  color: red }

div.system-message {
  border: medium outset ;
  padding: 1em }

div.system-message p.system-message-title {
  color: red ;
  font-weight: bold }

div.topic {
  margin: 2em }

h1.section-subtitle, h2.section-subtitle, h3.section-subtitle,
h4.section-subtitle, h5.section-subtitle, h6.section-subtitle {
  margin-top: 0.4em }

h1.title {
  text-align: center }

h2.subtitle {
  text-align: center }

hr.docutils {
  width: 75% }

img.align-left {
  clear: left }

img.align-right {
  clear: right }

ol.simple, ul.simple {
  margin-bottom: 1em }

ol.arabic {
  list-style: decimal }

ol.loweralpha {
  list-style: lower-alpha }

ol.upperalpha {
  list-style: upper-alpha }

ol.lowerroman {
  list-style: lower-roman }

ol.upperroman {
  list-style: upper-roman }

p.attribution {
  text-align: right ;
  margin-left: 50% }

p.caption {
  font-style: italic }

p.credits {
  font-style: italic ;
  font-size: smaller }

p.label {
  white-space: nowrap }

p.rubric {
  font-weight: bold ;
  font-size: larger ;
  color: maroon ;
  text-align: center }

p.sidebar-title {
  font-family: sans-serif ;
  font-weight: bold ;
  font-size: larger }

p.sidebar-subtitle {
  font-family: sans-serif ;
  font-weight: bold }

p.topic-title {
  font-weight: bold }

pre.address {
  margin-bottom: 0 ;
  margin-top: 0 ;
  font-family: serif ;
  font-size: 100% }

pre.literal-block, pre.doctest-block {
  margin-left: 2em ;
  margin-right: 2em ;
  background-color: #eeeeee }

span.classifier {
  font-family: sans-serif ;
  font-style: oblique }

span.classifier-delimiter {
  font-family: sans-serif ;
  font-weight: bold }

span.interpreted {
  font-family: sans-serif }

span.option {
  white-space: nowrap }

span.pre {
  white-space: pre }

span.problematic {
  color: red }

span.section-subtitle {
  /* font-size relative to parent (h1..h6 element) */
  font-size: 80% }

table.citation {
  border-left: solid 1px gray;
  margin-left: 1px }

table.docinfo {
  margin: 2em 4em }

table.docutils {
  margin-top: 0.5em ;
  margin-bottom: 0.5em }

table.footnote {
  border-left: solid 1px black;
  margin-left: 1px }

table.docutils td, table.docutils th,
table.docinfo td, table.docinfo th {
  padding-left: 0.5em ;
  padding-right: 0.5em ;
  vertical-align: top }

table.docutils th.field-name, table.docinfo th.docinfo-name {
  font-weight: bold ;
  text-align: left ;
  white-space: nowrap ;
  padding-left: 0 }

h1 tt.docutils, h2 tt.docutils, h3 tt.docutils,
h4 tt.docutils, h5 tt.docutils, h6 tt.docutils {
  font-size: 100% }

tt.docutils {
  background-color: #eeeeee }

ul.auto-toc {
  list-style-type: none }

</style>
</head>
<body>
<div class="document" id="roundup-features">
<h1 class="title">Roundup Features</h1>
<p>Roundup is a simple-to-use and -install issue-tracking system with
web, e-mail and command-line interfaces. It is based on the winning design
from Ka-Ping Yee in the Software Carpentry &quot;Track&quot; design competition.</p>
<dl class="docutils">
<dt><em>simple to install</em></dt>
<dd><ul class="first last simple">
<li>installation (including web interface) takes about 30 minutes</li>
<li>instant-gratification <tt class="docutils literal"><span class="pre">python</span> <span class="pre">demo.py</span></tt> :)</li>
<li>two templates included in the distribution for you to base your tracker on</li>
<li>play with the demo, customise it and then use <em>it</em> as the template for
your production tracker</li>
<li>requires <em>no</em> additional support software - python (2.3+) is
enough to get you going</li>
<li>easy to set up higher-performance storage backends like <a class="reference" href="http://www.hwaci.com/sw/sqlite/">sqlite</a>,
<a class="reference" href="http://www.equi4.com/metakit/">metakit</a>, <a class="reference" href="http://sourceforge.net/projects/mysql-python">mysql</a> and <a class="reference" href="http://initd.org/software/initd/psycopg">postgresql</a></li>
</ul>
</dd>
<dt><em>simple to use</em></dt>
<dd><ul class="first last simple">
<li>accessible through the web, email, command-line or Python programs</li>
<li>may be used to track bugs, features, user feedback, sales opportunities,
milestones, ...</li>
<li>automatically keeps a full history of changes to issues with
configurable verbosity and easy access to information about who created
or last modified <em>any</em> item in the database</li>
<li>issues have their own mini mailing list (nosy list)</li>
<li>users may sign themselves up, there may be automatic signup for
incoming email and users may handle their own password reset requests</li>
</ul>
</dd>
<dt><em>highly configurable</em></dt>
<dd><ul class="first last simple">
<li>web interface HTML is fully editable</li>
<li>database schema is also fully editable (only the &quot;user&quot; class is required)
with a full set of data types (including dates and many-to-many relations)
across all storages available</li>
<li>customised automatic auditors and reactors may be written that perform
actions before and after changes are made to entries in the database,
or may veto the creation or modification of items int he database</li>
<li>samples are provided for all manner of configuration changes and
customisations</li>
</ul>
</dd>
<dt><em>fast, scalable</em></dt>
<dd><ul class="first last simple">
<li>with the sqlite, metakit, mysql and postgresql backends, roundup is
also fast and scalable, easily handling thousands of issues and users
with decent response times</li>
<li>database indexes are automatically added for those backends that
support them (sqlite, metakit, mysql and postgresql)</li>
<li>indexed text searching giving fast responses to searches across all
messages and indexed string properties</li>
<li>support for the Xapian full-text indexing engine for large trackers</li>
</ul>
</dd>
<dt><em>documented</em></dt>
<dd><ul class="first last simple">
<li>documentation exists for installation, upgrading, maintenance, users and
customisation</li>
</ul>
</dd>
<dt><em>web interface</em></dt>
<dd><ul class="first last simple">
<li>fully editable interfaces for listing and display of items</li>
<li>extendable to include wizards, parent/meta bug displays, ...</li>
<li>differentiates between anonymous, known and admin users</li>
<li>may be set up to require login, and may also only allow admin users
to register new users</li>
<li>authentication of user registration and user-driven password resetting
using email and one time keys</li>
<li>may be run through CGI as a normal cgi script, as a stand-alone
web server, or through Zope</li>
<li>searching may be performed using many constraints, including a full-text
search of messages attached to issues</li>
<li>file attachments (added through the web or email) are served up with the
correct content-type and filename</li>
<li>email change messages generated by roundup appear to be sent by the
person who made the change, but responses will go back through the nosy
list by default</li>
<li>flexible access control built around Permissions and Roles with assigned
Permissions</li>
<li>generates valid HTML4 or XHTML</li>
<li>detects concurrent user changes</li>
<li>saving and editing of user-defined queries which may optionally be
shared with other users</li>
</ul>
</dd>
<dt><em>e-mail interface</em></dt>
<dd><ul class="first last simple">
<li>may be set up using sendmail-like delivery alias, POP polling or mailbox
polling</li>
<li>may auto-register users who send in mail and aren't known to roundup</li>
<li>nosy list configuration controls how people are added and when messages
are sent to the list</li>
<li>auto-filing of &quot;unformatted&quot; messages into a particular class</li>
<li>e-mail attachments are handled sanely, being attached to the issue they're
intended for, and forwarded on to the nosy list</li>
<li>sane handling of content-type and content-encoding of messages (text/plain
preferred in all situations)</li>
<li>email packages that display threading will show issue messages correctly
threaded</li>
<li>users may send in messages from multiple addresses and be associated
with the same roundup username</li>
<li>built-in security features like TLS and APOP</li>
</ul>
</dd>
<dt><em>command-line</em></dt>
<dd><ul class="first last simple">
<li>may be used to interactively manage roundup databases</li>
<li>may be scripted using standard shell scripting</li>
<li>roundup's API may also be used by other Python programs - a sample is
provided that runs once a day and emails people their assigned issues</li>
<li>a variety of sample shell scripts are provided (weekly reports, issue
generation, ...)</li>
</ul>
</dd>
</dl>
</div>
<div class="footer">
<hr class="footer" />
Generated on: 2006-08-09.

</div>
</body>
</html>