A Ployly Dash radar graph component.
Go to this link to learn about Dash.
# Install dependencies
npm install
# Watch source for changes and build to `lib/`
npm start
You can start up a demo development server on http://localhost:9000 to see a demo of the rendered components:
npm run demo
You have to maintain the list of components in demo/Demo.react.js
.
npm test
npm run test-watch
npm run test-debug
- Wait until Chrome launches.
- Click the "DEBUG" button in the top right corner.
- Open up Chrome Devtools (
Cmd+opt+i
). - Click the "Sources" tab.
- Find source files
- Navigate to
webpack:// -> . -> spec/components
to find your test source files. - Navigate to
webpack:// -> [your/repo/path]] -> radar-graph -> src
to find your component source files.
- Navigate to
- Now you can set breakpoints and reload the page to hit them.
- The test output is available in the "Console" tab, or in any tab by pressing "Esc".
In your test, append .only
to a describe
or it
statement:
describe.only('Foo component', () => {
// ...
})l
-
Build development bundle to
lib/
and watch for changes# Once this is started, you can just leave it running. npm start
-
Install module locally (after every change)
# Generate metadata, and build the JavaScript bundle npm run install-local # Now you're done. For subsequent changes, if you've got `npm start` # running in a separate process, it's enough to just do: python setup.py install
-
Run the dash layout you want to test
# Import radar-graph to your layout, then run it: python my_dash_layout.py
TODO: There is a workflow that links your module into site-packages
which would make it unnecessary to re-run 2.
on every change: python setup.py develop
. Unfortunately, this doesn't seem to work with resources defined in package_data
.
See https://github.com/plotly/dash-components-archetype/issues/20
Before publishing to PyPi, you can test installing the module locally:
# Install in `site-packages` on your machine
npm run install-local
npm run uninstall-local
For now, multiple steps are necessary for publishing to NPM and PyPi, respectively.
TODO: #5 will roll up publishing steps into one workflow.
Ask @chriddyp to get NPM / PyPi package publishing accesss.
-
Preparing to publish to NPM
# Bump the package version npm version major|minor|patch # Push branch and tags to repo git push --follow-tags
-
Preparing to publish to PyPi
# Bump the PyPi package to the same version vi setup.py # Commit to github git add setup.py git commit -m "Bump pypi package version to vx.x.x"
-
Publish to npm and PyPi
npm run publish-all
We use Builder to centrally manage build configuration, dependencies and scripts.
To see all builder
scripts available:
builder help
See the dash-components-archetype repo for more information.