doc/features.txt

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