Metadata-Version: 2.0
Name: dash-admin
Version: 0.1.14
Summary: A CLI for starting Dash projects
Home-page: https://github.com/gaw89/dash-admin
Author: Gideon Whitehead
Author-email: gideon.whitehead@uphs.upenn.edu
License: UNKNOWN
Keywords: cli
Platform: UNKNOWN
Classifier: Intended Audience :: Developers
Classifier: Topic :: Utilities
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Requires-Dist: docopt
Provides-Extra: test
Requires-Dist: coverage; extra == 'test'
Requires-Dist: pytest; extra == 'test'
Requires-Dist: pytest-cov; extra == 'test'

Dash-Admin
==========

Intro
~~~~~

Dash-Admin is an extension for `Dash`_ to help start new Dash projects.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Dash-Admin is modelled after the ``django-admin`` command in the popular
Python web framework `Django`_. The goal of dash-admin is to provide a
simple, easy-to-use CLI tool for starting projects in Dash.

Documentation
~~~~~~~~~~~~~

Getting a working Dash application is as simple as:

``dash-admin startproject myproject``

This will give you a working Dash application, complete with user
authentication, user management (both online and through the CLI), and a
main page with an interactive Plotly chart. To start the application
``cd`` to the ‘myproject’ folder which was just created and enter:

``python run.py``

then visit `localhost:8050/myproject/app1`_.

You can log in with username ``admin`` and password ``admin``.

Installation
~~~~~~~~~~~~

Dash-Admin can be installed via ``pip install dash-admin`` or by cloning
this repo and running ``python setup.py install``.

Note:
^^^^^

You will also need to run
``pip install https://github.com/gaw89/dash-auth/tarball/master#egg=dash-auth-0.1.0``
in order to provide user authentication.

.. _Dash: https://github.com/plotly/dash
.. _Django: https://github.com/django/django
.. _`localhost:8050/myproject/app1`: http://localhost:8050/myproject/app1


