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  - the really impatient can try the instant-gratification Demo Mode (``python
  17    demo.py``)
  18
  19 *simple to use*
  20  - accessible through the web, email, command-line or Python programs
  21  - may be used to track bugs, features, user feedback, sales opportunities,
  22    milestones, ...
  23  - keeps a full history of changes to issues with configurable verbosity
  24  - issues have their own mini mailing list (nosy list)
  25
  26 *highly configurable*
  27  - web interface HTML is fully editable
  28  - database schema is also fully editable (only the "user" class is required)
  29    with a full set of data types (including dates and many-to-many relations)
  30    across all storages available
  31  - customised automatic auditors and reactors may be written that perform
  32    actions before and after changes are made to entries in the database
  33  - samples are provided for all types of configuration changes
  34
  35 *fast, scalable*
  36  - with the sqlite_, metakit_ and mysql backends, roundup is also fast and
  37    scalable, easily handling thousands of issues and users with decent
  38    response times
  39  - indexed text searching giving fast responses to searches across all
  40    messages and indexed string properties
  41
  42 *documented*
  43  - documentation exists for installation, upgrading, maintenance, users and
  44    customisation
  45
  46 *web interface*
  47  - fully editable interfaces for listing and display of items
  48  - extendable to include wizards, parent/meta bug displays, ...
  49  - differentiates between anonymous, known and admin users
  50  - may be set up to require login, and may also only allow admin users
  51    to register new users
  52  - authentication of user registration and user-driven password resetting
  53    using email and one time keys
  54  - may be run through CGI as a normal cgi script, as a stand-alone
  55    web server, or through Zope
  56  - searching may be performed using many constraints, including a full-text
  57    search of messages attached to issues
  58  - file attachments (added through the web or email) are served up with the
  59    correct content-type and filename
  60  - email change messages generated by roundup appear to be sent by the
  61    person who made the change, but responses will go back through the nosy
  62    list by default
  63
  64 *e-mail interface*
  65  - may be set up using sendmail-like delivery alias, POP polling or mailbox
  66    polling
  67  - may auto-register users who send in mail and aren't known to roundup
  68  - nosy list configuration controls how people are added and when messages
  69    are sent to the list
  70  - auto-filing of "unformatted" messages into a particular class
  71  - e-mail attachments are handled sanely, being attached to the issue they're
  72    intended for, and forwarded on to the nosy list
  73  - sane handling of content-type and content-encoding of messages (text/plain
  74    preferred in all situations)
  75  - email packages that display threading will show issue messages correctly
  76    threaded
  77  - users may send in messages from multiple addresses and be associated
  78    with the same roundup username
  79  - built-in security features like TLS and APOP
  80
  81 *command-line*
  82  - may be used to interactively manage roundup databases
  83  - may be scripted using standard shell scripting
  84  - roundup's API may also be used by other Python programs - a sample is
  85    provided that runs once a day and emails people their assigned issues
  86  - a variety of sample shell scripts are provided (weekly reports, issue
  87    generation, ...)
  88
  89 .. _sqlite: http://www.hwaci.com/sw/sqlite/
  90 .. _metakit: http://www.equi4.com/metakit/
  91