Tipboard got open-sourced!

xordataexchange · Aug 28, 2014 · 60c073a · 60c073a
commit 60c073a
Show file tree

Hide file tree

Showing 166 changed files with 49,871 additions and 0 deletions.
diff --git a/.gitignore b/.gitignore
@@ -0,0  1,4 @@
 tipboard.egg-info/
 /.idea/*
 *.pyc
 *.swp
diff --git a/.travis.yml b/.travis.yml
@@ -0,0  1,15 @@
 language: python
 python:
   - "2.7"
 # command to install dependencies, e.g. pip install -r requirements.txt --use-mirrors
 install:
     - pip install flake8 --use-mirrors
     - pip install . --use-mirrors
 before_script:
     - flake8 --statistics tipboard
 # command to run tests, e.g. python setup.py test
 script:
     - tipboard test test_config_parser
     - tipboard test test_console_commands
     - tipboard test test_rest_api.TestRestApi.test_01_api_key
     - tipboard test test_rest_api.TestRestApi.test_02_info_resource
diff --git a/CHANGES.rst b/CHANGES.rst
@@ -0,0  1,123 @@
 Change Log
 ----------
 
 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
diff --git a/LICENSE.rst b/LICENSE.rst
@@ -0,0  1,13 @@
    Copyright 2013-2014 Allegro Group
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.
    You may obtain a copy of the License at
 
        http://www.apache.org/licenses/LICENSE-2.0
 
    Unless required by applicable law or agreed to in writing, software
    distributed under the License is distributed on an "AS IS" BASIS,
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and
    limitations under the License.
diff --git a/MANIFEST.in b/MANIFEST.in
@@ -0,0  1,6 @@
 include README.rst CHANGES.rst LICENSE.rst requirements.txt
 recursive-include tipboard/static *
 recursive-include tipboard/templates *
 recursive-include tipboard/tiles *
 recursive-include tipboard/defaults *
 recursive-include tipboard/extras *
diff --git a/README.rst b/README.rst
@@ -0,0  1,84 @@
 ========
 Tipboard
 ========
 
 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's instance. You may also point your favourite
 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-2014 `Allegro Group <http://allegrogroup.com>`_.