项目作者: plotly

项目描述 :
Control components for Dash
高级语言: JavaScript
项目地址: git://github.com/plotly/dash-daq.git
创建时间: 2018-03-06T02:13:52Z
项目社区:https://github.com/plotly/dash-daq

开源协议:MIT License

下载


dash_daq

DAQ components for Dash.

Docs: https://dash.plotly.com/dash-daq

Installation

pip install dash_daq

(Or for Python 3, pip3 install dash_daq)

Getting started for contributors

The source code and all the subsequent changes should be done inside src folder/directory.

Create a python virtual environment and activate it. inside that virtual enviornment

  1. pip install dash
  2. pip install pyyaml

This will install necessary build tools for building and testing library.

  1. # Clone this repository
  2. git clone https://github.com/plotly/dash-daq.git
  3. # Install dependencies
  4. $ npm install --also=dev
  5. # Watch source for changes and build to `lib/`
  6. $ npm start

Documentation

Component API documentation can be found at https://dash.plotly.com/dash-daq

Development

Demo server

You can start up a demo development server to see a demo of the rendered
components:

  1. $ npm run dash-demo

You have to maintain the list of components in demo/Demo.react.js.

Code quality and tests

To run lint and unit tests:

  1. $ npm run test

Testing your components in Dash

  1. Build development bundle to lib/
  1. $ npm run start
  1. Install module locally (after every change) in virtual environment
  1. # Generate metadata, and install the daq pacakage locally for testing
  2. $ npm run install-local
  1. Run the Dash demo
  1. $ npm run dash-demo

Installing python package locally

Before publishing to PyPi, you can test installing the module locally:

  1. # Install in `site-packages` on your machine
  2. $ yarn run install-local

Uninstalling python package locally

  1. $ yarn run uninstall-local

Producing a new release as a tarball

  1. vim dash_daq/version.py # and increase it to X.X.X
  2. rm -rf node_modules dist build lib
  3. yarn install
  4. yarn build-tarball
  5. ls dist/dash_daq-X.X.X.tar.gz # this is your tarball

Demo applications