131 lines
5.1 KiB
Plaintext
131 lines
5.1 KiB
Plaintext
|
Metadata-Version: 2.1
|
||
|
|
Name: dash-bootstrap-components
|
||
|
|
Version: 1.5.0
|
||
|
|
Summary: Bootstrap themed components for use in Plotly Dash
|
||
|
|
Home-page: https://dash-bootstrap-components.opensource.faculty.ai/
|
||
|
|
Author: Faculty
|
||
|
|
Author-email: opensource@faculty.ai
|
||
|
|
License: Apache Software License
|
||
|
|
Project-URL: Bug Reports, https://github.com/facultyai/dash-bootstrap-components/issues
|
||
|
|
Project-URL: Source, https://github.com/facultyai/dash-bootstrap-components/
|
||
|
|
Classifier: Framework :: Dash
|
||
|
|
Classifier: License :: OSI Approved :: Apache Software License
|
||
|
|
Classifier: Programming Language :: Python :: 3.7
|
||
|
|
Classifier: Programming Language :: Python :: 3.8
|
||
|
|
Classifier: Programming Language :: Python :: 3.9
|
||
|
|
Classifier: Programming Language :: Python :: 3.10
|
||
|
|
Classifier: Programming Language :: Python :: 3.11
|
||
|
|
Requires-Python: >=3.7, <4
|
||
|
|
Description-Content-Type: text/markdown
|
||
|
|
License-File: LICENSE
|
||
|
|
License-File: NOTICE.txt
|
||
|
|
Requires-Dist: dash >=2.0.0
|
||
|
|
Provides-Extra: pandas
|
||
|
|
Requires-Dist: numpy ; extra == 'pandas'
|
||
|
|
Requires-Dist: pandas ; extra == 'pandas'
|
||
|
|
|
||
|
|
<h1>Dash Bootstrap Components</h1>
|
||
|
|
|
||
|
|
<p align="center">
|
||
|
|
<a href="https://dash-bootstrap-components.opensource.faculty.ai/">
|
||
|
|
<img src="https://cdn.opensource.faculty.ai/dbc/assets/logo.svg" alt="dash-bootstrap-components logo" width="200" height="200">
|
||
|
|
</a>
|
||
|
|
</p>
|
||
|
|
|
||
|
|
<p align="center">
|
||
|
|
Bootstrap components for Plotly Dash
|
||
|
|
<br>
|
||
|
|
<a href="https://dash-bootstrap-components.opensource.faculty.ai/">Explore the documentation </a>~
|
||
|
|
<a href="https://github.com/facultyai/dash-bootstrap-components/issues/new?template=bug.md">Report a bug </a>~
|
||
|
|
<a href="https://github.com/facultyai/dash-bootstrap-components/issues/new?template=feature.md">Request a feature</a>
|
||
|
|
<br>
|
||
|
|
<br>
|
||
|
|
<img alt="GitHub Actions" src="https://github.com/facultyai/dash-bootstrap-components/workflows/Tests/badge.svg?branch=main">
|
||
|
|
<img alt="GitHub" src="https://img.shields.io/github/license/facultyai/dash-bootstrap-components">
|
||
|
|
<img alt="PyPI" src="https://img.shields.io/pypi/v/dash-bootstrap-components">
|
||
|
|
<img alt="Conda (channel only)" src="https://img.shields.io/conda/vn/conda-forge/dash-bootstrap-components">
|
||
|
|
<img alt="PyPI - Python Version" src="https://img.shields.io/pypi/pyversions/dash-bootstrap-components">
|
||
|
|
</p>
|
||
|
|
|
||
|
|
_dash-bootstrap-components_ is a library of [Bootstrap][bootstrap-homepage]
|
||
|
|
components for use with [Plotly Dash][dash-homepage], that makes it easier to
|
||
|
|
build consistently styled Dash apps with complex, responsive layouts.
|
||
|
|
|
||
|
|
## Installation
|
||
|
|
|
||
|
|
### PyPI
|
||
|
|
|
||
|
|
You can install _dash-bootstrap-components_ with `pip`:
|
||
|
|
|
||
|
|
```sh
|
||
|
|
pip install dash-bootstrap-components
|
||
|
|
```
|
||
|
|
|
||
|
|
### Anaconda
|
||
|
|
|
||
|
|
You can also install _dash-bootstrap-components_ with `conda` through the
|
||
|
|
conda-forge channel:
|
||
|
|
|
||
|
|
```sh
|
||
|
|
conda install -c conda-forge dash-bootstrap-components
|
||
|
|
```
|
||
|
|
|
||
|
|
## Quick start
|
||
|
|
|
||
|
|
To use _dash-bootstrap-components_ you must do two things:
|
||
|
|
|
||
|
|
- Link a Bootstrap v5 compatible stylesheet
|
||
|
|
- Incorporate _dash-bootstrap-components_ into your layout
|
||
|
|
|
||
|
|
### Linking a stylesheet
|
||
|
|
|
||
|
|
_dash-bootstrap-components_ doesn't come with CSS included. This is to give you
|
||
|
|
the freedom to use any Bootstrap v5 stylesheet of your choice. This means
|
||
|
|
however that in order for the components to be styled properly, you must link
|
||
|
|
to a stylesheet yourself.
|
||
|
|
|
||
|
|
For convenience, links to [BootstrapCDN][bootstrapcdn] for each theme are
|
||
|
|
available through the `themes` module, which can be used as follows:
|
||
|
|
|
||
|
|
```python
|
||
|
|
import dash
|
||
|
|
import dash_bootstrap_components as dbc
|
||
|
|
|
||
|
|
app = dash.Dash(external_stylesheets=[dbc.themes.BOOTSTRAP])
|
||
|
|
```
|
||
|
|
|
||
|
|
For more information on how to link local or external CSS, check out the
|
||
|
|
[Dash documentation][dash-docs-external].
|
||
|
|
|
||
|
|
### Build the layout
|
||
|
|
|
||
|
|
With CSS linked, you can start building your app's layout with our Bootstrap
|
||
|
|
components. See our [_documentation_][docs-components] for a full list of
|
||
|
|
available components.
|
||
|
|
|
||
|
|
## Contributing
|
||
|
|
|
||
|
|
We welcome contributions to _dash-bootstrap-components_. If you find a bug or
|
||
|
|
something is unclear please [submit a bug report][bug-report], if you have ideas
|
||
|
|
for new features please feel free to make a [feature request][feature-request].
|
||
|
|
If you would like to submit a pull request, please read our
|
||
|
|
[contributing guide][contribution-guide].
|
||
|
|
|
||
|
|
## Copyright and license
|
||
|
|
|
||
|
|
Code and documentation is copyright [Faculty Science Ltd.][faculty]
|
||
|
|
2018-2022, and released under the [Apache 2.0 license](./LICENSE.txt)
|
||
|
|
|
||
|
|
[dash-homepage]: https://dash.plot.ly/
|
||
|
|
[dash-docs-external]: https:/dash.plot.ly/external-resources
|
||
|
|
[bootstrap-homepage]: https://getbootstrap.com/
|
||
|
|
[dbc-repo]: https://github.com/facultyai/dash-bootstrap-components
|
||
|
|
[reactstrap-homepage]: https://reactstrap.github.io/
|
||
|
|
[docs-homepage]: https://dash-bootstrap-components.opensource.faculty.ai
|
||
|
|
[docs-components]: https://dash-bootstrap-components.opensource.faculty.ai/l/components
|
||
|
|
[bootstrapcdn]: https://www.bootstrapcdn.com/
|
||
|
|
[faculty]: https://faculty.ai
|
||
|
|
[bug-report]: https://github.com/facultyai/dash-bootstrap-components/issues/new?template=bug.md
|
||
|
|
[feature-request]: https://github.com/facultyai/dash-bootstrap-components/issues/new?template=feature.md
|
||
|
|
[contribution-guide]: https://github.com/facultyai/dash-bootstrap-components/blob/main/.github/CONTRIBUTING.md
|