Django Segments is a Django app that provides a way to create nested ranges of ranges. In this package we provide abstract models for Spans, which contain a set of Segments. Elsewhere, this concept is sometimes refered to as a "range list" or "range set".
Note: Postgres has a multirange type, but there is no way to treat the ranges within a multirange as objects in their own right. This package provides a way to do that.
The Span model is essentially a wrapper around a range field, and each Span contains one or more non-overlapping Segment model instances (which are also wrappers around range fields). The Span model is used to represent an entire range, and the Segment model instances each represent a non-overlapping portion of that range.
There are other ways to accomplish these general goals, but this package provides a more structured way to work with ranges of ranges, and a number of helper methods that make it easier to create, manipulate, and view Spans and Segments.
This package is particularly useful for resourse scheduling and allocation, and can be used for a variety of other tasks.
This example is how the package will be used in a production application.
Imagine you are building a system that allows an Irrigation District's water users to request water deliveries. You could use a Span to represent the period of time that a user has requested water, and Segments to represent the portions of that time that the user has actually received water, with a new segment created each time the volumetric flow rate changes.
Imagine you are building a system that tracks work orders for a manufacturing plant or trouble tickets for a helpdesk. You could use a Span to represent the span of time for each work order or ticket, and Segments to represent the portions of time the work order or ticket was spent in a particular state (e.g.: "In Progress", "On Hold", "Completed").
Imagine you are building a system that analyzes log files. You could use a Span to represent each log file, and Segments to represent the portions of the log file that contain specific types of events.
Imagine you are building the schedule for a conference that runs from 8 am to 5 pm each day. You have a set of rooms, each of which can be scheduled for a specific time period. You could use a Span to represent the entire day for each room, and Segments to represent the time periods that each room is scheduled. The tools provided by this package would allow you to easily create, update (insert, delete, split, merge), and query the schedule for each room.
- Abstract models for building Spans and associated Segments
- Helper classes that can be used with multiple model variants (e.g.: two different models inheriting Span could use the same helper classes, use helper classes with overridden methods, or mix and match) and to aid in implementing forms and views.
- Extensive Tests
- Documentation
- Custom Django signals that allow the user to perform actions before and after each Operation is performed on a Span or Segment
- TODO
You can install django-segments via pip from PyPI:
$ pip install django_segmentsPlease see the Usage Section for details.
Contributions are very welcome. To learn more, see the Contributor Guide.
Distributed under the terms of the MIT license, django-segments is free and open source software.
If you encounter any problems, please file an issue along with a detailed description.
This project was generated from @OmenApps's Cookiecutter Django Package template.