JupyterDash 项目教程

JupyterDash 项目教程

jupyter-dashOBSOLETE - Dash v2.11+ has Jupyter support built in!项目地址:https://gitcode.com/gh_mirrors/ju/jupyter-dash

1. 项目的目录结构及介绍

JupyterDash 项目的目录结构如下：

jupyter-dash/
├── binder/
├── conda-recipe/
├── extensions/
│   └── jupyterlab/
├── jupyter_dash/
├── notebooks/
├── .gitignore
├── CHANGELOG.md
├── LICENSE.txt
├── MANIFEST.in
├── README.md
├── RELEASE.md
├── renovate.json
├── requirements-dev.txt
├── requirements.txt
├── setup.py

目录介绍

• binder/: 包含用于 Binder 的配置文件。
• conda-recipe/: 包含用于 Conda 包的配置文件。
• extensions/jupyterlab/: 包含 JupyterLab 扩展的相关文件。
• jupyter_dash/: 包含项目的主要代码文件。
• notebooks/: 包含示例 Jupyter Notebook 文件。
• .gitignore: Git 忽略文件配置。
• CHANGELOG.md: 项目更新日志。
• LICENSE.txt: 项目许可证。
• MANIFEST.in: 打包配置文件。
• README.md: 项目说明文档。
• RELEASE.md: 发布流程说明。
• renovate.json: Renovate 配置文件。
• requirements-dev.txt: 开发依赖文件。
• requirements.txt: 项目依赖文件。
• setup.py: 项目安装文件。

2. 项目的启动文件介绍

项目的启动文件是 setup.py。这个文件用于安装和管理项目的依赖，并提供了构建和发布项目的功能。

setup.py 文件介绍

from setuptools import setup, find_packages

setup(
    name='jupyter-dash',
    version='0.4.2',
    description='Develop Dash apps in the Jupyter Notebook and JupyterLab',
    long_description=open('README.md').read(),
    long_description_content_type='text/markdown',
    author='Plotly',
    author_email='hello@plot.ly',
    url='https://github.com/plotly/jupyter-dash',
    packages=find_packages(),
    install_requires=[
        'dash>=2.0.0',
        'jupyter-server-proxy',
    ],
    classifiers=[
        'Development Status :: 4 - Beta',
        'Intended Audience :: Developers',
        'Intended Audience :: Science/Research',
        'License :: OSI Approved :: MIT License',
        'Programming Language :: Python :: 3',
        'Programming Language :: Python :: 3.6',
        'Programming Language :: Python :: 3.7',
        'Programming Language :: Python :: 3.8',
        'Programming Language :: Python :: 3.9',
    ],
    python_requires='>=3.6',
)

主要功能

• 定义项目名称、版本和描述。
• 读取并设置长描述和内容类型。
• 设置作者和联系信息。
• 指定项目 URL 和包列表。
• 定义安装依赖。
• 设置分类器和 Python 版本要求。

3. 项目的配置文件介绍

项目的配置文件主要包括 requirements.txt 和 requirements-dev.txt。

requirements.txt 文件介绍

dash>=2.0.0
jupyter-server-proxy

requirements-dev.txt 文件介绍

pytest
flake8

主要功能

• requirements.txt: 列出了项目运行所需的依赖包及其版本。
• requirements-dev.txt: 列出了开发过程中所需的额外依赖包，如测试和代码检查工具。

以上是 JupyterDash 项目的目录结构、启动文件和配置文件的介绍。希望这些信息能帮助你更好地理解和使用该项目。

jupyter-dashOBSOLETE - Dash v2.11+ has Jupyter support built in!项目地址:https://gitcode.com/gh_mirrors/ju/jupyter-dash