# Notice
As of Dash 2, the development of dash-core-components has been moved to the [main Dash repo](https://github.com/plotly/dash)
This package exists for backward compatibility
---
# Dash Core Components
This package provides the core React component suite for [Dash][].
[](https://circleci.com/gh/plotly/dash-core-components)
## Development
The `dash` package contains some tools to build components and drive the bundles build process.
To avoid the circular dependency situation, we don't add `dash` as a required install in the `dash-core-components` setup.
But, in order to do development locally, you need to install `dash` before everything.
1. Install the dependencies with:
```bash
# it's recommended to install your python packages in a virtualenv
# python 2
$ pip install virtualenv --user && virtualenv venv && . venv/bin/activate
# python 3
$ python -m venv venv && . venv/bin/activate
# make sure dash is installed with dev and testing dependencies
$ pip install dash[dev,testing] # in some shells you need \ to escape []
# run the build process
$ npm i --ignore-scripts && npm run build
# install dcc in editable mode
$ pip install -e .
```
### Code quality and tests
### To run integration tests (test_integration.py)
You can run the Selenium integration tests with the
```sh
npm test
```
### Testing your components in Dash
1. Run the build watcher by running
$ npm run build:watch
2. Run the dash layout you want to test
# Import dash_core_components to your layout, then run it:
$ python my_dash_layout.py
## Uninstalling python package locally
```sh
$ npm run uninstall-local
```
## Publishing
There's an npm script that will handle publish, provided you have the right credentials. You can run it by running
```sh
$ npm run publish-all
```
See the [Publishing New Components/Features](CONTRIBUTING.md#publishing-new-componentsfeatures) section of the Contributing guide for step-by-step instructions on publishing new components.
## Dash Component Boilerplate
See the [dash-component-boilerplate](https://github.com/plotly/dash-component-boilerplate) repo for more information.
[Dash]: https://plotly.com/dash
[Dash Component Boilerplate]: (https://github.com/plotly/dash-component-boilerplate)
[NPM package authors]: https://www.npmjs.com/package/dash-core-components/access
[PyPi]: https://pypi.python.org/pypi
## Big Thanks
Cross-browser Testing Powered by [](https://saucelabs.com)
Raw data
{
"_id": null,
"home_page": "",
"name": "dash-core-components",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "",
"author": "Chris Parmer <chris@plotly.com>",
"author_email": "chris@plotly.com",
"download_url": "https://files.pythonhosted.org/packages/41/55/ad4a2cf9b7d4134779bd8d3a7e5b5f8cc757f421809e07c3e73bb374fdd7/dash_core_components-2.0.0.tar.gz",
"platform": "",
"description": "# Notice\n\nAs of Dash 2, the development of dash-core-components has been moved to the [main Dash repo](https://github.com/plotly/dash)\n\nThis package exists for backward compatibility\n\n---\n\n# Dash Core Components\n\nThis package provides the core React component suite for [Dash][].\n\n[](https://circleci.com/gh/plotly/dash-core-components)\n\n## Development\n\nThe `dash` package contains some tools to build components and drive the bundles build process.\nTo avoid the circular dependency situation, we don't add `dash` as a required install in the `dash-core-components` setup.\nBut, in order to do development locally, you need to install `dash` before everything.\n\n1. Install the dependencies with:\n\n```bash\n# it's recommended to install your python packages in a virtualenv\n# python 2\n$ pip install virtualenv --user && virtualenv venv && . venv/bin/activate\n# python 3\n$ python -m venv venv && . venv/bin/activate\n\n# make sure dash is installed with dev and testing dependencies\n$ pip install dash[dev,testing] # in some shells you need \\ to escape []\n\n# run the build process\n$ npm i --ignore-scripts && npm run build\n\n# install dcc in editable mode\n$ pip install -e .\n```\n\n### Code quality and tests\n\n### To run integration tests (test_integration.py)\nYou can run the Selenium integration tests with the\n```sh\nnpm test\n```\n\n### Testing your components in Dash\n1. Run the build watcher by running\n $ npm run build:watch\n\n2. Run the dash layout you want to test\n\n # Import dash_core_components to your layout, then run it:\n $ python my_dash_layout.py\n\n## Uninstalling python package locally\n\n```sh\n$ npm run uninstall-local\n```\n\n## Publishing\n\nThere's an npm script that will handle publish, provided you have the right credentials. You can run it by running\n\n```sh\n$ npm run publish-all\n```\n\nSee the [Publishing New Components/Features](CONTRIBUTING.md#publishing-new-componentsfeatures) section of the Contributing guide for step-by-step instructions on publishing new components.\n\n## Dash Component Boilerplate\n\nSee the [dash-component-boilerplate](https://github.com/plotly/dash-component-boilerplate) repo for more information.\n\n[Dash]: https://plotly.com/dash\n[Dash Component Boilerplate]: (https://github.com/plotly/dash-component-boilerplate)\n[NPM package authors]: https://www.npmjs.com/package/dash-core-components/access\n[PyPi]: https://pypi.python.org/pypi\n\n\n## Big Thanks\nCross-browser Testing Powered by [](https://saucelabs.com)",
"bugtrack_url": null,
"license": "MIT",
"summary": "Core component suite for Dash",
"version": "2.0.0",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "009ea29f726e84e531a36d56cff187e61d8c96d2cc253c5bcef9a7695acb7e6a",
"md5": "b79b427ebbd0a4afa6d27333855e5a2a",
"sha256": "52b8e8cce13b18d0802ee3acbc5e888cb1248a04968f962d63d070400af2e346"
},
"downloads": -1,
"filename": "dash_core_components-2.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b79b427ebbd0a4afa6d27333855e5a2a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 3822,
"upload_time": "2022-03-02T16:50:30",
"upload_time_iso_8601": "2022-03-02T16:50:30.899271Z",
"url": "https://files.pythonhosted.org/packages/00/9e/a29f726e84e531a36d56cff187e61d8c96d2cc253c5bcef9a7695acb7e6a/dash_core_components-2.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "4155ad4a2cf9b7d4134779bd8d3a7e5b5f8cc757f421809e07c3e73bb374fdd7",
"md5": "98f5516cc507ce1a894516ade3491735",
"sha256": "c6733874af975e552f95a1398a16c2ee7df14ce43fa60bb3718a3c6e0b63ffee"
},
"downloads": -1,
"filename": "dash_core_components-2.0.0.tar.gz",
"has_sig": false,
"md5_digest": "98f5516cc507ce1a894516ade3491735",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 3427,
"upload_time": "2021-09-03T17:11:19",
"upload_time_iso_8601": "2021-09-03T17:11:19.342431Z",
"url": "https://files.pythonhosted.org/packages/41/55/ad4a2cf9b7d4134779bd8d3a7e5b5f8cc757f421809e07c3e73bb374fdd7/dash_core_components-2.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2021-09-03 17:11:19",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "dash-core-components"
}
JSON