Metadata-Version: 2.1
Name: dash-useful-components
Version: 0.0.2
Summary: Additional useful components for Dash
Home-page: https://github.com/queyruto/dash-useful-components
Author: Olivier Queyrut <oqueyrut@gmail.com>
License: Apache-2.0
Description: # dash useful components
        
        dash useful components is a Dash component library.
        
        Get started with:
        1. Install Dash and its dependencies: https://dash.plot.ly/installation
        2. Run `python usage.py`
        3. Visit http://localhost:8050 in your web browser
        
        ## Contributing
        
        See [CONTRIBUTING.md](./CONTRIBUTING.md)
        
        ### Install dependencies
        
        If you have selected install_dependencies during the prompt, you can skip this part.
        
        1. Install npm packages
            ```
            $ npm install
            ```
        2. Create a virtual env and activate.
            ```
            $ virtualenv venv
            $ . venv/bin/activate
            ```
            _Note: venv\Scripts\activate for windows_
        
        3. Install python packages required to build components.
            ```
            $ pip install -r requirements.txt
            ```
        4. Install the python packages for testing (optional)
            ```
            $ pip install -r tests/requirements.txt
            ```
        
        ### Create a production build and publish:
        
        1. Build your code:
            ```
            $ npm run build
            ```
        2. Create a Python tarball
            ```
            $ python setup.py sdist
            ```
            This distribution tarball will get generated in the `dist/` folder
        
        3. Test your tarball by copying it into a new environment and installing it locally:
            ```
            $ pip install dash_useful_components-0.0.2.tar.gz
            ```
        
        4. If it works, then you can publish the component to NPM and PyPI:
            1. Publish on PyPI
                ```
                $ twine upload dist/*
                ```
            2. Cleanup the dist folder (optional)
                ```
                $ rm -rf dist
                ```
            3. Publish on NPM (Optional if chosen False in `publish_on_npm`)
                ```
                $ npm publish
                ```
                _Publishing your component to NPM will make the JavaScript bundles available on the unpkg CDN. By default, Dash serves the component library's CSS and JS locally, but if you choose to publish the package to NPM you can set `serve_locally` to `False` and you may see faster load times._
        
        5. Share your component with the community! https://community.plot.ly/c/dash
            1. Publish this repository to GitHub
            2. Tag your GitHub repository with the plotly-dash tag so that it appears here: https://github.com/topics/plotly-dash
            3. Create a post in the Dash community forum: https://community.plot.ly/c/dash
        
Platform: UNKNOWN
Classifier: Framework :: Dash
Description-Content-Type: text/markdown
