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
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
Built Distribution
Close
Hashes for webviz_core_components-0.3.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | d3333a928b953c5630732bdaf8ffd3a7628fe8cbcc3b714f9efcb342b7cc409f |
|
MD5 | e2465e630c643df760ba9dfc6ff65b18 |
|
BLAKE2b-256 | e62a68a7bc731769b61c70d599863863cf9d899007746081611995ac5e49e3f7 |
Close
Hashes for webviz_core_components-0.3.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 074559ba4191c3ee74e0e97e3f2ce1b72278850affb9250c52bee3d5445768b8 |
|
MD5 | 00972067aea908d3299145fa803ffb6a |
|
BLAKE2b-256 | 080c3a08606e2c3d60f8c5f0de62fe86ba746e918d7b0283f251623781d7a9df |