معرفی شرکت ها
dash-down-0.1.1rc3
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشترتوضیحات
-
| ویژگی | مقدار |
|---|---|
| سیستم عامل | - |
| نام فایل | dash-down-0.1.1rc3 |
| نام | dash-down |
| نسخه کتابخانه | 0.1.1rc3 |
| نگهدارنده | [] |
| ایمیل نگهدارنده | [] |
| نویسنده | emher |
| ایمیل نویسنده | emil.h.eriksen@gmail.com |
| آدرس صفحه اصلی | https://github.com/emilhe/dash-down |
| آدرس اینترنتی | https://pypi.org/project/dash-down/ |
| مجوز | MIT |
[](https://github.com/emilhe/dash-down/actions/workflows/python-test.yml)
[](https://codecov.io/gh/emilhe/dash-down)
The `dash-down` package provides tools to render markdown files into Plotly Dash component trees. Besides standard markdown syntax, a custom interpretation of the [directive syntax extension](https://mistune.readthedocs.io/en/latest/directives.html) makes it possible to embed Dash code blocks and/or applications (including callbacks). For a live demo, please take look at the [`dash-extensions` documentation](https://www.dash-extensions.com/getting-started/installation#a-example).
## Getting started
Make sure that you have setup [poetry](https://python-poetry.org/). Then run
poetry install
to install dependencies.
#### Running the example
poetry run python example.py
#### Running the tests
poetry run pytest
## Custom content
Custom content is rendered via the markdown [directive syntax extension](https://mistune.readthedocs.io/en/latest/directives.html). A directive has the following syntax,
.. directive-name:: directive value
:option-key: option value
:option-key: option value
full featured markdown text here
where the `directive-name` is mandatory, while the `value`, the `options` (specified as key value pairs), and the `text` are optional.
#### What directives are bundled?
Currently, the bundled directives are
* **api-doc** - a directive for rendering api documentation for a component
* **dash-proxy** - a directive for rendering dash apps (including interactivity)
#### How to create custom directives?
The easiest way to create a custom directive is to create a function with the following signature,
```python
from box import Box
from dash_extensions.enrich import DashBlueprint
def directive_name(value: str, text: str, options: Box[str, str], blueprint: DashBlueprint):
"""
:param value: the directive value (optional)
:param text: the markdown text (optional)
:param options: a Box object containing all key value pairs (optional)
:param blueprint: the DashBlueprint of the resulting Dash component tree, used e.g. for callback registration
:return: a Dash component
"""
...
```
Say, we want to make a new directive that yields a plot of the `iris` dataset. The code would then be along the lines of,
```python
import plotly.express as px
from box import Box
from dash_extensions.enrich import dcc, DashBlueprint
def graph(value: str, text: str, options: Box[str, str], blueprint: DashBlueprint):
df = getattr(px.data, options.dataset)()
fig = px.scatter(df, x=options.x, y=options.y)
return dcc.Graph(figure=fig)
```
With this directive defined, it is now possible to create a graph similar to [the one in the Dash docs](https://dash.plotly.com/dash-core-components/graph) with the following syntax,
.. graph::
:dataset: iris
:x: sepal_width
:y: sepal_length
To render a markdown file using the new, shiny directive, the syntax would be,
```python
from dash_extensions.enrich import DashProxy
from dash_down.express import md_to_blueprint_dmc, GITHUB_MARKDOWN_CSS_LIGHT
...
blueprint = md_to_blueprint_dmc('path_to_your_md_file', directives=[graph])
app = DashProxy(blueprint=blueprint, external_stylesheets=[GITHUB_MARKDOWN_CSS_LIGHT])
if __name__ == '__main__':
app.run_server()
```
A working example is bundled in the repo (see `example_custom_directive.py`).
#### How to customize the layout of the rendered blueprint?
The layout of the blueprint returned by the renderer can be customized by passing a custom app shell via the `shell` keyword of the `md_to_blueprint_dmc` function. A working example is bundled in the repo (see `example_code_renderer.py`).
Per default, the app shell is a `Div` element with `className="markdown-body"`. This class makes it possibly to use GitHub CSS for styling.
#### How to customize the way code is rendered with the DashProxyDirective?
The layout of the Dash apps rendered via the `DashProxyDirective` can be customized via the `dash_proxy_shell` keyword of the `md_to_blueprint_dmc` function. A working example is bundled in the repo (see `example_code_renderer.py`).
Per default, the app shell `Div` element with the code rendered as the first child and the resulting app rendered as the second.
#### How to customize the markdown rendering itself?
Make a subclass of `DashMantineRenderer` (or `DashHtmlRenderer`, if you prefer to start from raw HTML) and override the render function(s) for any element that you want to change. A good place to start would be to look at the `DashMantineRenderer` class itself for inspiration.
نیازمندی
| مقدار | نام |
|---|---|
| >=2.5.0 | dash |
| >=0.1.5 | dash-extensions |
| >=0.7.0 | dash-mantine-components |
| >=0.1.2,<0.2.0 | dash-iconify |
| ==2.0.4 | mistune |
| >=6.0.1,<7.0.0 | python-box |
زبان مورد نیاز
| مقدار | نام |
|---|---|
| >=3.7,<4.0 | Python |
نحوه نصب
نصب پکیج whl dash-down-0.1.1rc3:
pip install dash-down-0.1.1rc3.whl
نصب پکیج tar.gz dash-down-0.1.1rc3:
pip install dash-down-0.1.1rc3.tar.gz