# 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
```sh
# Clone this repository
git clone https://github.com/plotly/dash-daq.git
# Install dependencies
$ yarn
# Watch source for changes and build to `lib/`
$ yarn 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:
```sh
$ yarn demo
$ open http://localhost:9000
```
You have to maintain the list of components in `demo/Demo.react.js`.
### Code quality and tests
#### To run lint and unit tests:
```sh
$ yarn test
```
### Testing your components in Dash
1. Build development bundle to `lib/` and watch for changes
# Once this is started, you can just leave it running.
$ yarn start
2. Install module locally (after every change)
# Generate metadata, and build the JavaScript bundle
$ yarn install-local
# Now you're done. For subsequent changes, if you've got `yarn start`
# running in a separate process, it's enough to just do:
$ python setup.py install
3. Run the Dash demo
$ python demo.py
## Installing python package locally
Before publishing to PyPi, you can test installing the module locally:
```sh
# Install in `site-packages` on your machine
$ yarn run install-local
```
## Uninstalling python package locally
```sh
$ yarn run uninstall-local
```
## Producing a new release as a tarball
```sh
vim dash_daq/version.py # and increase it to X.X.X
rm -rf node_modules dist build lib
yarn install
yarn build-tarball
ls dist/dash_daq-X.X.X.tar.gz # this is your tarball
```
## Demo applications
* Dash Daq HP Multimeter - [http://dash-gallery.plotly.host/dash-daq-hp-multimeter](http://dash-gallery.plotly.host/dash-daq-hp-multimeter)
* Dash Daq IV Tracer - [http://dash-gallery.plotly.host/dash-daq-iv-tracer](http://dash-gallery.plotly.host/dash-daq-iv-tracer)
* Dash Daq LED Control - [http://dash-gallery.plotly.host/dash-daq-led](http://dash-gallery.plotly.host/dash-daq-led)
* Dash Daq Omega PID - [http://dash-gallery.plotly.host/dash-daq-omega-pid](http://dash-gallery.plotly.host/dash-daq-omega-pid)
* Dash Daq Pressure Gauge KJL - [http://dash-gallery.plotly.host/dash-daq-pressure-gauge-kjl](http://dash-gallery.plotly.host/dash-daq-pressure-gauge-kjl)
* Dash Daq Pressure Gauge Pfeiffer - [https://dash-gallery.plotly.host/dash-daq-pressure-gauge-pv](https://dash-gallery.plotly.host/dash-daq-pressure-gauge-pv)
* Dash Daq Robotic Arm Edge - [http://dash-gallery.plotly.host/dash-daq-robotic-arm](http://dash-gallery.plotly.host/dash-daq-robotic-arm)
* Dash Daq Sparki - [http://dash-gallery.plotly.host/dash-daq-sparki](http://dash-gallery.plotly.host/dash-daq-sparki)
* Dash Daq Stepper Motor - [http://dash-gallery.plotly.host/dash-daq-stepper-motor](http://dash-gallery.plotly.host/dash-daq-stepper-motor)
* Dash Tektronix 350 - [http://dash-gallery.plotly.host/dash-daq-tektronix350](http://dash-gallery.plotly.host/dash-daq-tektronix350)
* Dash Ocean Optics - [http://dash-gallery.plotly.host/dash-ocean-optics](http://dash-gallery.plotly.host/dash-ocean-optics)
Raw data
{
"_id": null,
"home_page": "http://github.com/plotly/dash-daq",
"name": "dash-daq",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "",
"author": "The Plotly Team <dashdaq@plotly.com>",
"author_email": "dashdaq@plotly.com",
"download_url": "https://files.pythonhosted.org/packages/16/c1/9c6adfc3646990965a5b2ca073f579cc9c09d15553fcfcd83aefd1255494/dash_daq-0.5.0.tar.gz",
"platform": "",
"description": "# dash_daq\n\nDAQ components for Dash.\n\nDocs: https://dash.plotly.com/dash-daq\n\n## Installation\n\n`pip install dash_daq` \n\n(Or for Python 3, `pip3 install dash_daq`)\n\n## Getting started for contributors\n\n```sh\n# Clone this repository\ngit clone https://github.com/plotly/dash-daq.git\n\n# Install dependencies\n$ yarn\n\n# Watch source for changes and build to `lib/`\n$ yarn start\n```\n\n## Documentation\nComponent API documentation can be found at https://dash.plotly.com/dash-daq\n\n## Development\n\n### Demo server\n\nYou can start up a demo development server to see a demo of the rendered\ncomponents:\n\n```sh\n$ yarn demo\n$ open http://localhost:9000\n```\n\nYou have to maintain the list of components in `demo/Demo.react.js`.\n\n### Code quality and tests\n\n#### To run lint and unit tests:\n\n```sh\n$ yarn test\n```\n\n### Testing your components in Dash\n\n1. Build development bundle to `lib/` and watch for changes\n\n # Once this is started, you can just leave it running.\n $ yarn start\n\n2. Install module locally (after every change)\n\n # Generate metadata, and build the JavaScript bundle\n $ yarn install-local\n\n # Now you're done. For subsequent changes, if you've got `yarn start`\n # running in a separate process, it's enough to just do:\n $ python setup.py install\n\n3. Run the Dash demo\n\n $ python demo.py\n\n\n## Installing python package locally\n\nBefore publishing to PyPi, you can test installing the module locally:\n\n```sh\n# Install in `site-packages` on your machine\n$ yarn run install-local\n```\n\n## Uninstalling python package locally\n\n```sh\n$ yarn run uninstall-local\n```\n\n\n## Producing a new release as a tarball\n\n```sh\nvim dash_daq/version.py # and increase it to X.X.X\nrm -rf node_modules dist build lib\nyarn install\nyarn build-tarball\nls dist/dash_daq-X.X.X.tar.gz # this is your tarball\n```\n\n## Demo applications \n * Dash Daq HP Multimeter - [http://dash-gallery.plotly.host/dash-daq-hp-multimeter](http://dash-gallery.plotly.host/dash-daq-hp-multimeter)\n * Dash Daq IV Tracer - [http://dash-gallery.plotly.host/dash-daq-iv-tracer](http://dash-gallery.plotly.host/dash-daq-iv-tracer)\n * Dash Daq LED Control - [http://dash-gallery.plotly.host/dash-daq-led](http://dash-gallery.plotly.host/dash-daq-led)\n * Dash Daq Omega PID - [http://dash-gallery.plotly.host/dash-daq-omega-pid](http://dash-gallery.plotly.host/dash-daq-omega-pid)\n * Dash Daq Pressure Gauge KJL - [http://dash-gallery.plotly.host/dash-daq-pressure-gauge-kjl](http://dash-gallery.plotly.host/dash-daq-pressure-gauge-kjl)\n * Dash Daq Pressure Gauge Pfeiffer - [https://dash-gallery.plotly.host/dash-daq-pressure-gauge-pv](https://dash-gallery.plotly.host/dash-daq-pressure-gauge-pv)\n * Dash Daq Robotic Arm Edge - [http://dash-gallery.plotly.host/dash-daq-robotic-arm](http://dash-gallery.plotly.host/dash-daq-robotic-arm)\n * Dash Daq Sparki - [http://dash-gallery.plotly.host/dash-daq-sparki](http://dash-gallery.plotly.host/dash-daq-sparki)\n * Dash Daq Stepper Motor - [http://dash-gallery.plotly.host/dash-daq-stepper-motor](http://dash-gallery.plotly.host/dash-daq-stepper-motor)\n * Dash Tektronix 350 - [http://dash-gallery.plotly.host/dash-daq-tektronix350](http://dash-gallery.plotly.host/dash-daq-tektronix350)\n * Dash Ocean Optics - [http://dash-gallery.plotly.host/dash-ocean-optics](http://dash-gallery.plotly.host/dash-ocean-optics)",
"bugtrack_url": null,
"license": "",
"summary": "DAQ components for Dash",
"version": "0.5.0",
"project_urls": {
"Homepage": "http://github.com/plotly/dash-daq"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "16c19c6adfc3646990965a5b2ca073f579cc9c09d15553fcfcd83aefd1255494",
"md5": "116becd448b2de6688ebe81077bbc3da",
"sha256": "a1d85b6799f7b885652fbc44aebdb58c41254616a8d350b943beeb42ade4256a"
},
"downloads": -1,
"filename": "dash_daq-0.5.0.tar.gz",
"has_sig": false,
"md5_digest": "116becd448b2de6688ebe81077bbc3da",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 642707,
"upload_time": "2020-04-27T14:23:01",
"upload_time_iso_8601": "2020-04-27T14:23:01.125607Z",
"url": "https://files.pythonhosted.org/packages/16/c1/9c6adfc3646990965a5b2ca073f579cc9c09d15553fcfcd83aefd1255494/dash_daq-0.5.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2020-04-27 14:23:01",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "plotly",
"github_project": "dash-daq",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"circle": true,
"requirements": [],
"lcname": "dash-daq"
}
JSON
