Mercurial > p > roundup > code

comparison doc/features.txt @ 7990:788afca5aa15

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
docs: fixups to features lists. Rearrange features under different/better headings. Try to use parallel phrasing for items in list. Still a lot to do here to better market Roundup and increase users/contributors.
author John Rouillard <rouilj@ieee.org>
date Sat, 25 May 2024 19:26:49 -0400
parents 1632bdbfbef6
children 4ed91247e8dc
comparison
equal deleted inserted replaced
7989:bee475ae8653 7990:788afca5aa15
6 6
7 ================ 7 ================
8 Roundup Features 8 Roundup Features
9 ================ 9 ================
10 10
11 Roundup is a simple-to-use and -install issue-tracking system with 11 Roundup is an easy-to-use and -install issue-tracking system with
12 web, e-mail and command-line interfaces. It is based on the winning design 12 web, e-mail and command-line interfaces. Based on the winning design
13 from Ka-Ping Yee in the :index:`Software Carpentry` "Track" design competition. 13 from Ka-Ping Yee in the :index:`Software Carpentry` "Track" design competition.
14 14
15 *simple to install* 15 *simple to install*
16 - instant-gratification ``python demo.py`` takes less than 5 minutes :)
16 - installation (including web interface) takes about 30 minutes 17 - installation (including web interface) takes about 30 minutes
17 - instant-gratification ``python demo.py`` takes less than 5 minutes :)
18 - five templates included in the distribution for you to base your tracker on 18 - five templates included in the distribution for you to base your tracker on
19 - play with the demo, customise it and then use *it* as the template for 19 - play with the demo, customise it and then use *it* as the template for
20 your production tracker 20 your production tracker
21 - requires *no* additional support software - python (2.7 or 3.6+) is 21 - requires *no* additional support software - python (3.6+ or 2.7) is
22 enough to get you going 22 enough to get you going
23 - supports higher-performance storage backends like sqlite_, 23 - supports embedded databases like sqlite_ and dbm so you don't
24 mysql_ and postgresql_ 24 need a separate database like mysql_ or postgresql_
25 25
26 *simple to use* 26 *simple to use*
27 - accessible through the web (html, REST or XMLRPC), email, 27 - accessible through the web (html, REST or XMLRPC), email,
28 command-line or Python programs 28 command-line or Python programs
29 - may be used to track bugs, features, user feedback, sales opportunities, 29 - use it to track bugs, features, user feedback, sales opportunities,
30 milestones, ... 30 fleet maintenance requests, office issues, milestones, ...
31 - issues have their own mini mailing list (nosy list)
32 - indexed Full Text Search (FTS) gives fast responses to searches across all
33 messages and indexed string properties
34 - users may sign themselves up, there may be automatic signup for
35 incoming email and users may handle their own password reset requests
31 - automatically keeps a full history of changes to issues with 36 - automatically keeps a full history of changes to issues with
32 configurable verbosity and easy access to information about who created 37 configurable verbosity and easy access to information about who created
33 or last modified *any* item in the database 38 or last modified *any* item in the database
34 - issues have their own mini mailing list (nosy list)
35 - users may sign themselves up, there may be automatic signup for
36 incoming email and users may handle their own password reset requests
37 39
38 *highly configurable* 40 *highly configurable*
39 - web interface HTML is fully editable 41 - web interface HTML is fully editable
40 - database schema is also fully editable (only the "user" class is required) 42 - database schema is also fully editable (only the "user" class is required)
41 with a full set of data types (including dates and many-to-many relations) 43 with a full set of data types (including dates and many-to-many relations)
42 across all storages available 44 across all storages available
43 - authorization is fine grained and can be based on the properties of 45 - fine grained authorization can be based on the properties of
44 a user and resource (`ABAC, PBAC (Attribute or Policy/Purpose Based Access 46 a user and resource (`Attribute or Policy/Purpose Based Access
45 Control <https://en.wikipedia.org/wiki/Attribute-based_access_control>`_)) 47 Control (ABAC or PBAC)
46 - customised automatic auditors and reactors may be written that perform 48 <https://en.wikipedia.org/wiki/Attribute-based_access_control>`_))
49 - customised automatic auditors and reactors to perform
47 actions before and after changes are made to entries in the database, 50 actions before and after changes are made to entries in the database,
48 or may veto the creation or modification of items in the database 51 or may veto the creation or modification of items in the database
49 - samples are provided for all manner of configuration changes and 52 - samples are provided for all manner of configuration changes and
50 customisations 53 customisations
51 54
53 - with the sqlite, mysql and postgresql backends, roundup is 56 - with the sqlite, mysql and postgresql backends, roundup is
54 also fast and scalable, easily handling thousands of issues and users 57 also fast and scalable, easily handling thousands of issues and users
55 with decent response times 58 with decent response times
56 - database indexes are automatically added for those backends that 59 - database indexes are automatically added for those backends that
57 support them (sqlite, mysql and postgresql) 60 support them (sqlite, mysql and postgresql)
58 - indexed full text search (FTS) gives fast responses to searches across all
59 messages and indexed string properties
60 - support for the Xapian, Whoosh, sqlite or postgres full-text 61 - support for the Xapian, Whoosh, sqlite or postgres full-text
61 indexing engines for large trackers 62 indexing engines for large trackers
62 63
63 *documented* 64 *documented*
64 - documentation exists for installation, upgrading, maintenance, users and 65 - documentation exists for installation, upgrading, maintenance, users and
70 - differentiates between anonymous, known and admin users 71 - differentiates between anonymous, known and admin users
71 - may be set up to require login, and may also only allow admin users 72 - may be set up to require login, and may also only allow admin users
72 to register new users 73 to register new users
73 - authentication of user registration and user-driven password resetting 74 - authentication of user registration and user-driven password resetting
74 using email and one time keys 75 using email and one time keys
75 - may be run using WSGI or through CGI as a normal cgi script, as a 76 - may be run using a stand alone web server, WSGI (with mod_wsi or
76 stand-alone web server, under mod_wsgi (mod_python is deprecated) 77 the depricated mod_python under Apache), as a plain cgi script, or
77 or through Zope 78 through Zope
78 - searching may be performed using many constraints, including a full-text 79 - searching may be performed using many constraints, including a full-text
79 search of messages attached to issues 80 search of messages attached to issues
80 - file attachments (added through the web or email) are served up with the 81 - file attachments (added through the web or email) are served up with the
81 correct content-type and filename 82 correct content-type and filename
82 - email change messages generated by roundup appear to be sent by the 83 - email change messages generated by roundup appear to be sent by the
106 - built-in security features like TLS and APOP 107 - built-in security features like TLS and APOP
107 108
108 *command-line* 109 *command-line*
109 - may be used to interactively manage roundup databases 110 - may be used to interactively manage roundup databases
110 - may be scripted using standard shell scripting 111 - may be scripted using standard shell scripting
111 - roundup's API may also be used by other Python programs - a sample is 112 - roundup's API may also be used by other Python programs - for
112 provided that runs once a day and emails people their assigned issues 113 example a Python script torun daily email people their assigned
114 issues is provided
113 - a variety of sample shell scripts are provided (weekly reports, issue 115 - a variety of sample shell scripts are provided (weekly reports, issue
114 generation, ...) 116 generation, ...)
115 117
116 *xmlrpc interface* 118 *xmlrpc interface*
117 - simple remote tracker interface with basic HTTP authentication 119 - simple remote tracker interface with basic HTTP authentication
Roundup Issue Tracker: http://roundup-tracker.org/