tipboard 1.4.3

Tipboard - a flexible solution for creating your dashboards.

========
Tipboard
========

|docs|

Introduction
------------

Tipboard is a system for creating dashboards, written in JavaScript and Python.
Its widgets ('tiles' in Tipboard's terminology) are completely separated from
data sources, which provides great flexibility and relatively high degree of
possible customizations.

Because of its intended target (displaying various data and statistics in your
office), it is optimized for larger screens.

Similar projects: `Geckoboard <http://www.geckoboard.com/>`_,
`Dashing <http://shopify.github.io/dashing/>`_.

A detailed, technical documentation for Tipboard can be found
`here <http://tipboard.readthedocs.org/en/latest/>`_.


Quick start
-----------

Requirements
~~~~~~~~~~~~

Assuming Ubuntu or similar Linux distribution, some required packages need
to be installed first::

$ sudo apt-get install python-dev python-virtualenv redis-server

Virtual environment
~~~~~~~~~~~~~~~~~~~

Continue by creating a virtual environment that will help you conveniently
separate your instance from what you already have installed in the system
(let's say we will name it "tb-env")::

$ virtualenv tb-env

Activate the created virtual environment with the following command::

$ source tb-env/bin/activate

Installation with pip
~~~~~~~~~~~~~~~~~~~~~

After creating and activating virtualenv, install the latest (current) version
of Tipboard package available on `pypi <https://pypi.python.org/pypi>`_
("Python Package Index") with the following command::

(tb-env)$ pip install tipboard

Next, you need to create a configuration template for your dashboard - let's
say we will call it 'my_test_dashboard'::

(tb-env)$ tipboard create_project my_test_dashboard

This command will create ``.tipboard`` directory in your home dir and will
fill it with default settings for your dashboard.

Verification
~~~~~~~~~~~~

To verify your installation, launch this command::

(tb-env)$ tipboard runserver

If you see the message ``Listening on port...`` instead of any errors, it means
that installation was successful and you may now
`configure <http://tipboard.readthedocs.org/en/latest/configuration.html>`_
your newly installed Tipboard instance. You may also point your favorite
web browser to ``http://localhost:7272`` to see the current state of your
dashboard.


License
-------

Tipboard is licensed under the `Apache License, v2.0 <http://tipboard.readthedocs.org/en/latest/license.html>`_.

Copyright (c) 2013-2017 `Allegro Group <http://allegrogroup.com>`_.

.. |docs| image:: https://readthedocs.org/projects/tipboard/badge/?version=latest
:alt: Documentation Status
:scale: 100%
:target: https://readthedocs.org/projects/tipboard/

Change Log
----------

1.4.1
~~~~~

Released on November 16, 2016.

* Fixes for tiles: 'advanced_plot', 'simple_percentage' and 'text-tile'.

* Fix for tile keys cache.

* Added support for RequireJS.

* Make use of simplify.js to make charts (in e.g. 'line_chart' tile) more readable.

* Fix for 'Target dimension not set' error when layout 'row_1_of_1' is used.

* Minor fixes, improvements, cleanups etc.


1.4.0
~~~~~

Released on August 28, 2014.

* Tipboard got open-sourced!


1.3.1
~~~~~

Released on July 23, 2014.

* Added extensive documentation.

* Numerous fixes in 'jira-ds' script (e.g added timeouts).

* Fixed definitions of colors available for tiles.

* Fixed checking for expired data (+ made it timezone aware).

* Added integration with Travis.

* Changed default size of the log files.


1.3.0
~~~~~

Released on February 17, 2014.

New features:

* Fading highlighter (for just_value, big_value and simple_percentage tiles).

* Fancy centering options for fancy_listing tile.

* Notifications on data expiration.

* New tile: norm_chart.

* Possibility to define more than one dashboard per application instance.


Bug fixes:

* Tiles no longer vanish when flipping is enabled.

* Characters like '.' or '-' (and some others) in tiles' ids are no longer
causing problems.

* Renderer names (like OHLCRenderer, MarkerRenderer, ShadowRenderer and
ShapeRenderer) can now safely be passed to tiles' configs.


Others:

* Error messages displayed on tiles got more emphasis.

* Renderer names (in tiles' configs) are now case insensitive.

* Added frontend tests and selector for tests.


1.2.0
~~~~~

Released on December 19, 2013.

This release brings new features and some minor bugfixes.

* New tiles: big_value, just_value, advanced_plot.

* Rewritten 'jira-ds' script with some new options (e.g. 'maxResults' for JQL).

* Completely new graphic theme - with new colors, fonts etc.

* Fixed existing tests and some new added.

* Exceptions raised by JavaScript are now displayed on the tiles.

* Improved config handling for bar_chart, pie_chart and line_chart.

* Added possibility to specify specialized renderers for almost all plots
(except cumulative_flow).


1.1.0
~~~~~

Released on November 20, 2013.

This release contains multiple improvements and bugfixes:

* Tiles are no longer packages (i.e. folders).

* Reorganized files/folders structure.

* Massively reduced app's settings.

* Simplified layout config (no more classes, only one keyword needed to get
tile flips working).

* New tiles: bar_chart, fancy_listing.

* Improved scaling of tiles + some cosmetic changes.

* Unique API key is generated automatically for every project.

* Fabric script for administrative installs


1.0.0
~~~~~

Released on November 06, 2013.

This is the first release of Tipboard.

* initial release