Pelican-Jupyter 开源项目教程

Pelican-Jupyter 开源项目教程

pelican-jupyter Pelican plugin for blogging with Jupyter/IPython Notebooks 项目地址: https://gitcode.com/gh_mirrors/pe/pelican-jupyter

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

pelican-jupyter/
├── AUTHORS            # 项目作者信息
├── CHANGELOG.md       # 项目变更日志
├── CONTRIBUTING.md    # 贡献者指南
├── LICENSE            # 项目许可证
├── MANIFEST.in        # 打包文件清单
├── README.md          # 项目简介和使用说明
├──_requirements.txt   # 项目依赖的Python包
├── setup.py           # 项目安装脚本
├── pelican_jupyter/   # 项目核心代码目录
│   ├── __init__.py
│   ├── readers.py     # Jupyter笔记本读取器
│   └── tests/         # 测试代码目录
│       ├── __init__.py
│       └── test_readers.py
└── themes/            # 项目主题目录
    └── jupyter/       # Jupyter主题相关文件
        ├── static/
        └── templates/

目录结构说明

• AUTHORS: 列出项目的作者信息。
• CHANGELOG.md: 记录项目的版本变更和历史更新。
• CONTRIBUTING.md: 提供如何为项目贡献代码的指南。
• LICENSE: 项目使用的许可证文件。
• MANIFEST.in: 定义项目打包时需要包含的文件。
• README.md: 项目的基本介绍和使用说明。
• _requirements.txt: 列出项目依赖的Python包。
• setup.py: 用于安装项目的Python脚本。
• pelican_jupyter/: 包含项目的核心代码。
  • readers.py: 用于读取Jupyter笔记本的代码。
  • tests/: 包含项目的测试代码。
• themes/: 包含项目的主题文件。
  • jupyter/: Jupyter主题相关的静态文件和模板。

2. 项目的启动文件介绍

项目的启动文件主要是通过setup.py来进行安装和配置。以下是setup.py的基本结构和功能：

from setuptools import setup

setup(
    name='pelican-jupyter',
    version='0.2.1',
    description='A Pelican plugin to convert Jupyter notebooks to reStructuredText articles',
    long_description=open('README.md').read(),
    long_description_content_type='text/markdown',
    author='Daniel Rodriguez',
    author_email='daniel@inarow.me',
    url='https://github.com/danielfrg/pelican-jupyter',
    packages=['pelican_jupyter'],
    install_requires=[
        'pelican>=3.7.1',
        'nbconvert>=5.4',
        'traitlets>=4.3.2'
    ],
    classifiers=[
        'Framework :: Pelican :: Plugins',
        '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',
    ],
    entry_points={
        'pelican.plugins': [
            'jupyter = pelican_jupyter.readers:PelicanJupyterReaders',
        ]
    }
)

启动文件说明

• name: 项目名称。
• version: 项目版本号。
• description: 项目简短描述。
• long_description: 项目详细描述，通常读取自README.md。
• author: 项目作者。
• author_email: 作者邮箱。
• url: 项目URL。
• packages: 项目包含的Python包。
• install_requires: 项目依赖的Python包。
• classifiers: 项目分类信息。
• entry_points: 定义Pelican插件的入口点。

3. 项目的配置文件介绍

项目的配置文件主要是通过Pelican的配置文件来进行设置。以下是一些关键的配置项：

Pelican配置文件示例

# pelicanconf.py

PLUGIN_PATHS = ['path/to/pelican-jupyter']
PLUGINS = ['jupyter']

JUPYTER_KWARGS = {
    'exclude_input': True,
    'exclude_output': False,
    'exclude_input_prompt': True,
    'exclude_output_prompt': True,
    'include_raw': True,
    'include_unknown': True,
    'include_input': True,
    'include_output': True,
    'input_prompt': 'In [%s]:',
    'output_prompt': 'Out[%s]:',
}

配置项说明

• PLUGIN_PATHS: 指定插件路径。
• PLUGINS: 启用的插件列表，包含jupyter。
• JUPYTER_KWARGS:

pelican-jupyter Pelican plugin for blogging with Jupyter/IPython Notebooks 项目地址: https://gitcode.com/gh_mirrors/pe/pelican-jupyter