skip to navigation
skip to content

Not Logged In

holodeck 0.1.1

Django based simple dashboard system.

Holodeck

Django based simple dashboard system.

Demo Screenshot

https://github.com/downloads/shaunsephton/holodeck/screenie.0.1.0.png

Getting Started

Environment Setup

Before installing Holodeck it is strongly recommended that you create a sandboxed environment using virtualenv or the like. To do so go to a path in which you want to create a Holodeck instance and issue the following command:

$ virtualenv ve

Then activate your virtualenv:

$ . ve/bin/activate

Now install Holodeck using pip:

$ pip install holodeck

Once installed you should be able to execute the Holodeck CLI using holodeck, i.e:

$ holodeck
usage: holodeck [--config=/path/to/settings.py] [command] [options]

By default the CLI looks for a configuration file in the current working path called holodeck.conf.py.

Configuration Initialization

Holodeck allows you to specify settings to tweak it's behaviour for your particular use case. To generate a default settings file use the init command. init allows you to specify an alternative path (otherwise it defaults to the current working path):

$ holodeck init
Configuration file created at '/home/bill/holodeck/holodeck.conf.py'

# or with custom path

$ holodeck init /etc/holodeck.conf.py
Configuration file created at '/etc/holodeck.conf.py'

Then you can customize Holodeck and Django settings within the generated file (defaults to holodeck.conf.py), for instance which database engine you want to use.

Creating Database Tables

Once you are happy with your configration you have to create the various database tables required by Holodeck. Do this using the upgrade command:

$ holodeck upgrade

Remember to ensure that the configured database exists as specified in your configuration in case you are not using the default SQLite database.

Running Local Instance

With Holodeck installed and configured you can now fire up a local Holodeck instance using the runserver command:

$ holodeck runserver

Then access the instance on http://localhost:8000.

Pushing Data

Python users can use Photon to push data to Holodeck. Photon includes examples you can use as a starting point.

Authors

Created By

  1. shaunsephton

Changelog

0.1.1 (2012-10-15)

  1. Added mouse hover date formatter #6.
  2. Widget groupings consistent on timestamp #11.
  3. Samples are now unique on metric, string_value and timestamp, with existing sample integer_value fields being overriden on push #13.

0.1.0 (2012-08-25)

  1. Added gage metric type #7.
  2. Added drag and drop ordering of metrics on dashboard view #9.
  3. Switched to Bootstrap scaffolding for metric/widget alignment/responsiveness #10.

0.0.9 (2012-08-16)

  1. Prevented duplicate samples from breaking export (duplicates are ignored).
  2. Prevented widgets from affecting each other through context copy.
  3. Corrected broken footer links.

0.0.8 (2012-08-15)

  1. Added Dashboard manage/edit view.
  2. Allowed for purging of metric samples #2
  3. Added public/sharing urls for dashboards #4

0.0.7 (2012-08-14)

  1. Added Excel export action on Dashboard view.

0.0.6

  1. Switched to using logan
 
File Type Py Version Uploaded on Size
holodeck-0.1.1-py2.7.egg (md5) Python Egg 2.7 2012-10-15 345KB
holodeck-0.1.1.tar.gz (md5) Source 2012-10-15 290KB
  • Downloads (All Versions):
  • 1 downloads in the last day
  • 286 downloads in the last week
  • 1033 downloads in the last month