Skip to main content

Time-series API implementation in Django

This is an implementation of the OpenOrg time-series API specification as a Django application.

Features

  • Stores data in a compact binary format for quick retrieval

  • Archives data in CSV format to negate format-based lock-in

  • Time-zone aware

  • Customisable aggregation (e.g. for daily and weekly averages, minima and maxima)

  • Implements an API used by other time-series implementations

  • Allows creation, modification and updating of time-series from a RESTful web service

  • Has a fine-grained permissions model for administering time-series

Features yet to be implemented

  • Administration interface is still somewhat human-unfriendly

  • Customisable alerts for when series haven’t been updated for some period of time

  • Gauge and counter-based series (currently only period-based series)

  • Virtual time-series (i.e. time-series which are some function of other time-series)

Architecture

This project comprises a Django application that you can include in an existing Django project by adding 'openorg_timeseries' to your INSTALLED_APPS variable in your Django settings file.

openorg_timeseries.longliving contains a threading.Thread which mediates access to the underlying data, and which prevents …

Demonstration application

This project comes with a demonstration web service which you can use to quickly evaluate its usefulness.

Running

First, install the necessary dependencies using pip:

$ pip install -r requirements.txt

Next, start the demonstration server using the following:

$ django-admin.py rundemo –settings=openorg_timeseries.demo.settings –pythonpath=.

Give it a few seconds, after which you can point a web browser at http://localhost:8000/ <http://localhost:8000/ to see it in action.

Details

The demo site performs the following steps on start-up:

  1. Creates a demo-data directory in the current directory to store data used by the demo

  2. Runs the syncdb Django management command to create a sqlite3 database in the demo-data directory

  3. Starts a long-living process which manages the data storage and retrieval

  4. Creates a new time-series and loads in some example data

  5. Runs the runserver management command (without the auto-reloader) to start the Django development server

Metadata

Release files for openorg-timeseries 0.1.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for openorg-timeseries 0.1.1
File Size Uploaded
openorg-timeseries-0.1.1.tar.gz 39.8 kB Details

Release files / openorg-timeseries-0.1.1.tar.gz

Download URL openorg-timeseries-0.1.1.tar.gz
Size 39.8 kB
Tags Source
SHA-256 checksum
How to use checksums
b5ff0fb1a8f3f57ee9dcecea6d294829dfd2b02edd21dec1717e4678bad22c80
BLAKE2b-256 checksum
How to use checksums
d71e27a4ce0cee1798fa399a013c866428a3a14c20380a0ec2aa3743e77b7806
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release history Release notifications | RSS feed

This release

0.1.1 This release

1 release file

0.1

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page