一个用于将现有库和项目转换为nbdev的小型库
项目描述
lib2nbdev
一个将您的现有库和项目转换为
nbdev
的综合性包。由Novetta开发。
nbdev是一个旨在将文档、测试和源代码生成集中在一个地方(Jupyter笔记本)的出色工作流程。然而,如果您已经有一个现有项目,那么转换您的库的唯一方法是通过手动任务(可能需要> 30小时)。
lib2nbdev
就是解决方案!
相反,我们可以对任何现有库进行一次性的转换。在转换过程中,库将帮助您为项目生成合适的 settings.ini
配置文件。然而,您也可以自己生成 settings.ini
并将其放在项目的主目录中,例如
lib2nbdev
settings.ini
lib2nbdev
convert.py
要生成有效的 settings.ini
,请参阅此处的示例以及相关的 nbdev 文档
安装
pip安装lib2nbdev
如何使用
在项目目录中(在bash中),只需运行
convert_lib
它将自动生成所需的笔记本,并将任何可能需要私有化的函数(名称前有 _
的函数)私有化,以便在生成的文档中不显示。
之后,您将拥有一个功能齐全的 nbdev
库,并可以利用其所有优点!
Windows用户注意
如果您想使用此库,您应该
- 使用 Windows Subsystem for Linux (WSL2)
- 使用Windows中的Python3解释器
python3
from lib2nbdev.convert import convert_lib; convert_lib()
重要提示
这是一个一次性的转换,不允许进行重复的Python到笔记本的转换。
项目详情
下载文件
下载适用于您的平台的文件。如果您不确定选择哪个,请了解更多关于安装包的信息。
源分布
lib2nbdev-1.0.0.tar.gz (14.3 kB 查看散列)
构建分布
lib2nbdev-1.0.0-py3-none-any.whl (13.3 kB 查看散列)