doc/features.txt

   1 ================
   2 Roundup Features
   3 ================
   4
   5
   6 Roundup is a simple-to-use and -install issue-tracking system with
   7 web, e-mail and command-line interfaces. It is based on the winning design
   8 from Ka-Ping Yee in the Software Carpentry "Track" design competition.
   9
  10
  11 *simple to use*
  12  - accessible through the web, email, command-line or Python programs
  13  - may be used to track bugs, features, user feedback, sales opportunities,
  14    ...
  15  - keeps a full history of changes to issues
  16
  17 *simple to install*
  18  - installation takes about 10 minutes for a basic installation
  19  - two "template" schemas included in the distribution for you to base your
  20    tracker on
  21  - doesn't need any additional support software - python (2.1+) is enough to
  22    get you going
  23
  24 *web interface*
  25  - fully editable interfaces for indexing and display of items
  26  - differentiates between anonymous, known and admin users
  27  - may be set up to require login, and may also only allow admin users
  28    to register new users
  29  - may be run through CGI as a normal cgi script, as a stand-alone
  30    web server, or through Zope
  31  - searching may be performed using many constraints, including a full-text
  32    search of messages attached to issues
  33  - file attachments (added through the web or email) are served up with the
  34    correct content-type and filename
  35  - email change messages generated by roundup appear to be sent by the
  36    person who made the change, but responses will go back through the nosy
  37    list by default
  38
  39 *e-mail interface*
  40  - may be set up using sendmail-like delivery alias, POP polling or mailbox
  41    polling
  42  - issues have their own mini mailing list (nosy list)
  43  - may auto-register users who send in mail and aren't known to roundup
  44  - nosy list configuration controls how people are added and when messages
  45    are sent to the list
  46  - auto-filing of "unformatted" messages into a particular class
  47  - e-mail attachments are handled sanely, being attached to the issue they're
  48    intended for, and forwarded on to the nosy list
  49  - sane handling of content-type and content-encoding of messages (text/plain
  50    preferred in all situations)
  51  - email packages that display threading will show issue messages correctly
  52    threaded
  53  - users may send in messages from multiple addresses and be associated
  54    with the same roundup username
  55
  56 *command-line*
  57  - may be used to interactively manage roundup databases
  58  - may be scripted using standard shell scripting
  59  - roundup's API may also be used by other Python programs - a sample is
  60    provided that runs once a day and emails people their assigned issues
  61
  62 *highly configurable*
  63  - web interface HTML is fully editable
  64  - database schema is also fully editable
  65  - customised automatic auditors and reactors may be written that perform
  66    actions before and after changes are made to entries in the database
  67  - samples are provided for all types of configuration changes
  68