Text of roundup.sourceforge.io › docs › design.html as Styx crawled it on Nov 19, 2026. The page may have changed since. Only its words are kept, without pictures or layout, and only the first part of a long page.

Open the live page

Roundup - An Issue-Tracking System for Knowledge Workers - Roundup 2.6.0 documentation

Skip to main content Roundup - An Issue-Tracking System for Knowledge Workers Authors : Ka-Ping Yee ( original ), Richard Jones (implementation) Contents Introduction This document presents a description of the components of the Roundup system and specifies their interfaces and behaviour in sufficient detail to guide an implementation. For the philosophy and rationale behind the Roundup design, see the first-round Software Carpentry submission for Roundup .

This document fleshes out that design as well as specifying interfaces so that the components can be developed separately. The Layer Cake Lots of software design documents come with a picture of a cake. Everybody seems to like them. I also like cakes (I think they are tasty). So I, too, shall include a picture of a cake here: ________________________________________________________________ | E - mail Client | Web Browser | Detector Scripts | Shell | |---------------+---------------+--------------------+-----------| | E - mail User | Web User | Detector | Command | |----------------------------------------------------------------| | Roundup Database Layer | |----------------------------------------------------------------| | Hyperdatabase Layer | |----------------------------------------------------------------| | Storage Layer | ---------------------------------------------------------------- The colourful parts of the cake are part of our system; the faint grey parts of the cake are external components.

I will now proceed to forgo all table manners and eat from the bottom of the cake to the top. You may want to stand back a bit so you don’t get covered in crumbs. Hyperdatabase The lowest-level component to be implemented is the hyperdatabase. The hyperdatabase is a flexible data store that can hold configurable data in records which we call items. The hyperdatabase is implemented on top of the storage layer, an external module for storing its data.

The “batteries-includes” distribution implements the hyperdatabase on the standard anydbm module. The storage layer could be a third-party RDBMS; for a low-maintenance solution, implementing the hyperdatabase on the SQLite RDBMS is suggested. Dates and Date Arithmetic Before we get into the hyperdatabase itself, we need a way of handling dates. The hyperdatabase module provides Timestamp objects for representing date-and-time stamps and Interval objects for representing date-and-time intervals.

As strings, date-and-time stamps are specified with the date in ISO8601 international standard format ( yyyy-mm-dd ) joined to the time ( hh:mm:ss ) by a period “ . ”. Dates in this form can be easily compared and are fairly readable when printed. An example of a valid stamp is “ 2000-06-24.13:03:59 ”. We’ll call this the “full date format”. When Timestamp objects are printed as strings, they appear in the full date format with the time always given in GMT.

The full date format is always exactly 19 characters long. For user input, some partial forms are also permitted: the whole time or just the seconds may be omitted; and the whole date may be omitted or just the year may be omitted. If the time is given, the time is interpreted in the user’s local time zone. The Date constructor takes care of these conversions. In the following examples, suppose that yyyy is the current year, mm is the current month, and dd is the current day of the month; and suppose that the user is on Eastern Standard Time.

“2000-04-17” means <Date 2000-04-17.00:00:00> “01-25” means <Date yyyy-01-25.00:00:00> “2000-04-17.03:45” means <Date 2000-04-17.08:45:00> “08-13.22:13” means <Date yyyy-08-14.03:13:00> “11-07.09:32:43” means <Date yyyy-11-07.14:32:43> “14:25” means <Date yyyy-mm-dd.19:25:00> “8:47:11” means <Date yyyy-mm-dd.13:47:11> the special date “.” means “right now” Date intervals are specified using the suffixes “y”, “m”, and “d”.

The suffix “w” (for “week”) means 7 days. Time intervals are specified in hh:mm:ss format (the seconds may be omitted, but the hours and minutes may not). “3y” means three years “2y 1m” means two years and one month “1m 25d” means one month and 25 days “2w 3d” means two weeks and three days “1d 2:50” means one day, two hours, and 50 minutes “14:00” means 14 hours “0:04:33” means four minutes and 33 seconds The Date class should understand simple date expressions of the form stamp + interval and stamp - interval .

When adding or subtracting intervals involving months or years, the components are handled separately. For example, when evaluating “ 2000-06-25 + 1m 10d ”, we first add one month to get 2000-07-25, then add 10 days to get 2000-08-04 (rather than trying to decide whether 1m 10d means 38 or 40 or 41 days). Here is an outline of the Date and Interval classes: class Date : def __init__ ( self , spec , offset ): """Construct a date given a specification and a time zone offset. 'spec' is a full date or a partial form, with an optional added or subtracted interval. 'offset' is the local time zone offset from GMT in hours.

""" def __add__ ( self , interval ): """Add an interval to this date to produce another date.""" def __sub__ ( self , interval ): """Subtract an interval from this date to produce another date. """ def __cmp__ ( self , other ): """Compare this date to another date.""" def __str__ ( self ): """Return this date as a string in the yyyy-mm-dd.hh:mm:ss format. """ def local ( self , offset ): """Return this date as yyyy-mm-dd.hh:mm:ss in a local time zone.

""" class Interval : def __init__ ( self , spec ): """Construct an interval given a specification.""" def __cmp__ ( self , other ): """Compare this interval to another interval.""" def __str__ ( self ): """Return this interval as a string.""" Here are some examples of how these classes would behave in practice. For the following examples, assume that we are on Eastern Standard Time and the current local time is 19:34:02 on 25 June 2000: >>> Date ( "." ) <Date 2000-06-26.00:34:02> >>> _ . local ( - 5 ) "2000-06-25.19:34:02" >>> Date ( ". + 2d" ) <Date 2000-06-28.00:34:02> >>> Date ( "1997-04-17" , - 5 ) <Date 1997-04-17.00:00:00> >>> Date ( "01-25" , - 5 ) <Date 2000-01-25.00:00:00> >>> Date ( "08-13.22:13" , - 5 ) <Date 2000-08-14.03:13:00> >>> Date ( "14:25" , - 5 ) <Date 2000-06-25.19:25:00> >>> Interval ( " 3w 1 d 2:00" ) <Interval 22d 2:00> >>> Date ( ". + 2d" ) - Interval ( "3w" ) <Date 2000-06-07.00:34:02> Items and Classes Items contain data in properties.

To Python, these properties are presented as the key-value pairs of a dictionary. Each item belongs to a class which defines the names and types of its properties. The database permits the creation and modification of classes as well as items. Identifiers and Designators Each item has a numeric identifier which is unique among items in its class. The items are numbered sequentially within each class in order of creation, starting from 1.

The designator for an item is a way to identify an item in the database, and consists of the name of the item’s class concatenated with the item’s numeric identifier. For example, if “spam” and “eggs” are classes, the first item created in class “spam” has id 1 and designator “spam1”. The first item created in class “eggs” also has id 1 but has the distinct designator “eggs1”. Item designators are conventionally enclosed in square brackets when mentioned in plain text.

This permits a casual mention of, say, “[patch37]” in an e-mail message to be turned into an active hyperlink. Property Names and Types Property names must begin with a letter. A property may be one of five basic types: String properties are for storing arbitrary-length strings. Boolean properties are for storing true/false, or yes/no values. Integer properties are for storing Integer (non real) numeric values. Number properties are for storing numeric values.

Date properties store date-

The rest of this page is on the live site.