Update README. Add pypi setup.

README.rst

@@ -0,0 +1,118 @@
+===========
+Finish Line
+===========
+
+Finish Line is a framework for quickly building beautiful customizable dashboards in Plotly Dash.
+The framework provides utility for developers to easily plugin new interactive visualization
+components into the dashboard. Components are automatically added to the dashboard using a responsive
+grid layout.
+
+----------------------
+How to use Finish Line
+----------------------
+
+An example use of the framework is located in the GitHub repo under the ``example`` directory. The
+following shows the minimum code required to start a Finish Line dashboard server.
+
+.. code:: python
+
+    from finishline import FinishLine
+    import dash
+
+    app = dash.Dash()
+    data = load_my_data()
+
+    fl = FinishLine(app=app, data=data)
+    fl.load_plugins()
+    app.layout = fl.generate_layout()
+
+    if __name__ == '__main__':
+        fl.run_server(debug=True, port=5000, host='0.0.0.0')
+        
+Visualization components are loaded from the ``plugins`` folder. The default location is in a folder
+called ``plugins`` in the current working directory (directory the web server is started). Individual
+plugins are located in subfolders under the ``plugins`` folder. The entry point to a plugin is in the
+file ``__init__.py``.
+
+Here is an example component. The code is placed in ``./plugins/HelloWorld/__init__.py``
+
+.. code:: python
+
+    import dash_html_components as html
+    import dash_core_components as dcc
+
+    def initialize(app, data, fl):
+
+        fl.register_vis(
+            'HelloWorld',
+            dcc.Graph(
+                id='basic-chart',
+                figure={
+                    'data': [
+                        {
+                            'x': [1, 2, 3, 4],
+                            'y': [4, 1, 3, 5],
+                            'text': ['a', 'b', 'c', 'd'],
+                            'customdata': ['c.a', 'c.b', 'c.c', 'c.d'],
+                            'name': 'Trace 1',
+                            'mode': 'markers',
+                            'marker': {'size': 12}
+                            },
+                        {
+                            'x': [1, 2, 3, 4],
+                            'y': [9, 4, 1, 4],
+                            'text': ['w', 'x', 'y', 'z'],
+                            'customdata': ['c.w', 'c.x', 'c.y', 'c.z'],
+                            'name': 'Trace 2',
+                            'mode': 'markers',
+                            'marker': {'size': 12}
+                            }
+                        ]
+                    },
+                config={
+                    'autosizable': True
+                    }
+                )
+        )
+        
+    def finalize(app, data, fl):
+        pass
+
+
+------------
+Installation
+------------
+
+Finish Line depends upon ``dash``. Note, we have only tested with ``python3``.
+
+Requirements:
+
+* dash
+* dash-responsive-grid-layout
+
+**Install Options**
+
+.. code:: bash
+
+    pip3 install finishline
+
+
+--------
+Features
+--------
+
+* Client and server side data store API
+* Plugin visualization component API
+* Responsive grid layout
+* Customizable grid layout via drag and drop
+* Developer mode
+
+----------
+To Do List
+----------
+
+* Save layout
+* Reusable components API
+* Hide/Show components
+* Support multiple pages
+* Better support for resizing plotly charts

setup.py

@@ -0,0 +1,41 @@
+from setuptools import setup
+
+def readme():
+    with open('README.rst') as readme_file:
+        return readme_file.read()
+
+configuration = {
+    'name' : 'finishline',
+    'version': '0.0.1',
+    'description' : 'Framework for Building Beautiful and Functional Dashbords',
+    'long_description' : readme(),
+    'classifiers' : [
+        'Development Status :: 3 - Alpha',
+        'Intended Audience :: Science/Research',
+        'Intended Audience :: Developers',
+        'License :: OSI Approved',
+        'Programming Language :: Python',
+        'Topic :: Software Development',
+        'Topic :: Scientific/Engineering',
+        'Operating System :: Microsoft :: Windows',
+        'Operating System :: POSIX',
+        'Operating System :: Unix',
+        'Operating System :: MacOS',
+        'Programming Language :: Python :: 3 :: Only',
+    ],
+    'keywords' : 'dash dashboard ui grid layout',
+    'url' : 'http://github.com/AlgorithmHub/finishline',
+    'maintainer' : 'Alex Cabello',
+    'maintainer_email' : '[email protected]',
+    'license' : 'MIT',
+    'packages' : ['finishline'],
+    'install_requires': ['dash >= 0.22.0',
+                         'dash-responsive-grid-layout >= 0.0.1'],
+    'ext_modules' : [],
+    'cmdclass' : {},
+    'test_suite' : '',
+    'tests_require' : [],
+    'data_files' : ()
+    }
+
+setup(**configuration)