{ "info": { "author": "Oxford University Computing Services", "author_email": "opendata@oucs.ox.ac.uk", "bugtrack_url": null, "classifiers": [ "Development Status :: 4 - Beta", "Framework :: Django", "License :: OSI Approved :: BSD License", "Natural Language :: English", "Operating System :: OS Independent", "Programming Language :: Python", "Topic :: Internet :: WWW/HTTP :: Dynamic Content" ], "description": "Time-series API implementation in Django\n========================================\n\nThis is an implementation of the OpenOrg `time-series API specification\n`_ as a Django application.\n\n\nFeatures\n--------\n\n* Stores data in a compact binary format for quick retrieval\n* Archives data in CSV format to negate format-based lock-in\n* Time-zone aware\n* Customisable aggregation (e.g. for daily and weekly averages, minima and maxima)\n* Implements an API used by other time-series implementations\n* Allows creation, modification and updating of time-series from a RESTful web service\n* Has a fine-grained permissions model for administering time-series\n\n\nFeatures yet to be implemented\n------------------------------\n\n* Administration interface is still somewhat human-unfriendly\n* Customisable alerts for when series haven't been updated for some period of time\n* Gauge and counter-based series (currently only period-based series)\n* Virtual time-series (i.e. time-series which are some function of other time-series)\n \n\nArchitecture\n------------\n\n\nThis project comprises a Django application that you can include in an existing\nDjango project by adding ``'openorg_timeseries'`` to your ``INSTALLED_APPS``\nvariable in your Django settings file.\n\n``openorg_timeseries.longliving`` contains a ``threading.Thread`` which mediates access to the underlying data, and which prevents ...\n\nDemonstration application\n-------------------------\n\nThis project comes with a demonstration web service which you can use to quickly evaluate its usefulness.\n\nRunning\n~~~~~~~\n\nFirst, install the necessary dependencies using pip:\n\n $ pip install -r requirements.txt\n\nNext, start the demonstration server using the following:\n\n $ django-admin.py rundemo --settings=openorg_timeseries.demo.settings --pythonpath=.\n\nGive it a few seconds, after which you can point a web browser at `http://localhost:8000/