Jupyter Bokeh 开源项目教程
项目的目录结构及介绍
Jupyter Bokeh 项目的目录结构如下:
jupyter_bokeh/
├── LICENSE
├── MANIFEST.in
├── README.md
├── RELEASE.md
├── docs/
│ ├── Makefile
│ ├── _static/
│ ├── _templates/
│ ├── conf.py
│ ├── index.rst
│ ├── make.bat
│ └── source/
├── examples/
│ ├── README.md
│ ├── bokeh_app/
│ ├── extensions/
│ ├── notebooks/
│ └── standalone/
├── jupyter_bokeh/
│ ├── __init__.py
│ ├── _version.py
│ ├── bokeh_renderer.py
│ ├── extension.py
│ ├── labextension/
│ │ ├── package.json
│ │ └── static/
│ ├── nbextension/
│ │ ├── extension.js
│ │ └── index.js
│ └── tests/
│ ├── __init__.py
│ ├── conftest.py
│ ├── test_bokeh_renderer.py
│ └── test_extension.py
├── pyproject.toml
├── setup.cfg
└── setup.py
主要目录和文件介绍
LICENSE
: 项目的许可证文件。README.md
: 项目的基本介绍和使用说明。docs/
: 项目的文档目录,包含 Sphinx 文档构建配置和源文件。examples/
: 包含各种示例,如 Bokeh 应用、扩展和 Jupyter Notebook 示例。jupyter_bokeh/
: 项目的主要代码目录,包含核心功能实现和测试代码。pyproject.toml
,setup.cfg
,setup.py
: 项目的构建和分发配置文件。
项目的启动文件介绍
Jupyter Bokeh 项目的启动文件主要涉及 Jupyter 扩展和 Bokeh 渲染器的初始化。以下是关键的启动文件:
jupyter_bokeh/extension.py
: 该文件定义了 Jupyter 扩展的初始化逻辑,包括加载 Bokeh 渲染器和相关资源。jupyter_bokeh/bokeh_renderer.py
: 该文件实现了 Bokeh 图表的渲染逻辑,使得 Bokeh 图表可以在 Jupyter Notebook 和 JupyterLab 中显示。
项目的配置文件介绍
Jupyter Bokeh 项目的配置文件主要用于项目的构建和分发,以及文档的生成。以下是关键的配置文件:
setup.py
: 用于项目的安装和分发,定义了项目的依赖、元数据和安装脚本。setup.cfg
: 包含项目的构建和分发配置,如包的版本、作者信息等。pyproject.toml
: 定义了项目的构建系统和其他配置,如依赖管理工具 Poetry 的配置。docs/conf.py
: 用于 Sphinx 文档生成系统的配置,定义了文档的构建选项、主题和扩展。
通过这些配置文件,可以确保项目在不同环境下的正确安装和文档的顺利生成。