Core components for webviz config
Project description
Webviz core components
webviz_core_components
is a Dash component library for use in webviz
.
You can quickly get started with:
- Run
pip install webviz-core-components
- Run
python usage.py
- Visit http://localhost:8050 in your web browser
:warning: The components here are used by
webviz-config
. In order to facilitate a strong CSP configuration, this package has a side effect of changing the Plotly distribution coming withdash-core-components
to one that do not rely oneval()
. More specifically it changes fromplotly-full
toplotly-cartesian
bundle. This will be necessary in order to enforce a strong CSP configuration as long as thisplotly
issue and thisdash-core-components
issue both are open. Note that this side-effect only takes place ifdash-core-components
is installed, which is a requirement if theGraph
component from this repository is going to be used.
How to contribute
Install dependencies
If you want to build and develop yourself, you should fork + clone the repository, and then:
- Install npm packages
npm ci --ignore-scripts
- Run the project's own
postinstall
scriptnpm run postinstall
- Install python packages required to build components.
pip install .[dependencies] pip install dash[dev]
- Install the python packages for testing.
The second of these commands appears to be necessary as long as thispip install .[tests] pip install dash[testing]
pip
issue is open.
Write component code in src/lib/components/<component_name>.react.js
-
The demo app is in
src/demo
and is where you will import an example of your component. To start the existing demo app, runnpm start
. -
To test your code in a Python environment:
- Build your code
npm run build
- Install the Python pacakge in development mode (if not already done and
assuming you are using a virtual environment):
pip install -e .
- Create a new example in
examples/
which uses your new component.
- Build your code
-
Write tests for your component.
- Tests exist in
tests/
. Take a look at them to see how to write tests using the Dash test framework. - Run the tests with
pytest tests
.
- Tests exist in
-
Add custom styles to your component by putting your custom CSS files into your distribution folder (
webviz_core_components
).- Make sure that they are referenced in
MANIFEST.in
so that they get properly included when you're ready to publish your component. - Make sure the stylesheets are added to the
_css_dist
dict inwebviz_core_components/__init__.py
so dash will serve them automatically when the component suite is requested.
- Make sure that they are referenced in
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Hashes for webviz_core_components-0.0.12.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3fa39e981ddcbd4663b485f84caeaf28cf900a27f0589b16925081996b281838 |
|
MD5 | 6b55669022f4529b6b30f9d80905cc44 |
|
BLAKE2b-256 | 1b934c2dd0710b10c2012b6b7a480844aa3555a03b3c6b4fc24d75eb94623a36 |