开源项目 notebook-as-pdf 使用教程

开源项目 notebook-as-pdf 使用教程

notebook-as-pdfSave Jupyter Notebooks as PDF项目地址:https://gitcode.com/gh_mirrors/no/notebook-as-pdf

项目目录结构及介绍

notebook-as-pdf/
├── LICENSE
├── README.md
├── notebook_as_pdf
│   ├── __init__.py
│   ├── nbfilter.py
│   ├── nbpdf.py
│   └── pdf.py
├── setup.py
└── tests
    ├── __init__.py
    └── test_notebook_as_pdf.py

• LICENSE: 项目的许可证文件。
• README.md: 项目说明文档。
• notebook_as_pdf: 项目的主要代码目录。
  • init.py: 初始化文件。
  • nbfilter.py: 处理 Jupyter Notebook 文件的过滤器。
  • nbpdf.py: 主要功能文件，负责将 Notebook 转换为 PDF。
  • pdf.py: 处理 PDF 生成的相关功能。
• setup.py: 项目的安装配置文件。
• tests: 测试代码目录。
  • init.py: 初始化文件。
  • test_notebook_as_pdf.py: 测试用例文件。

项目启动文件介绍

项目的启动文件是 nbpdf.py，它包含了将 Jupyter Notebook 转换为 PDF 的主要逻辑。以下是 nbpdf.py 的主要功能：

• 读取 Jupyter Notebook 文件。
• 处理 Notebook 内容，去除不必要的页面中断。
• 使用 Chromium 渲染生成 PDF。
• 将原始 Notebook 文件附加到生成的 PDF 中，以保证可重复性。

项目配置文件介绍

项目的配置文件是 setup.py，它包含了项目的安装和依赖信息。以下是 setup.py 的主要内容：

• 项目名称、版本和描述。
• 项目的依赖库。
• 项目的入口点，指定启动文件。

from setuptools import setup, find_packages

setup(
    name='notebook-as-pdf',
    version='0.5.0',
    description='Jupyter extension to export notebooks as PDFs',
    long_description=open('README.md').read(),
    long_description_content_type='text/markdown',
    author='Tim Head',
    author_email='betatim@gmail.com',
    url='https://github.com/betatim/notebook-as-pdf',
    packages=find_packages(),
    install_requires=[
        'notebook',
        'pyppeteer',
        'PyPDF2',
    ],
    entry_points={
        'console_scripts': [
            'notebook-as-pdf=notebook_as_pdf.nbpdf:main',
        ],
    },
    classifiers=[
        'License :: OSI Approved :: BSD License',
        'Programming Language :: Python :: 3',
        'Programming Language :: Python :: 3.7',
    ],
)

通过以上配置，用户可以使用 pip install notebook-as-pdf 命令来安装该项目，并通过命令行启动文件 notebook-as-pdf 来使用项目的主要功能。

notebook-as-pdfSave Jupyter Notebooks as PDF项目地址:https://gitcode.com/gh_mirrors/no/notebook-as-pdf