将课程材料转换为naucse.python.cz api
naucse-render的Python项目详细描述
Naucse_渲染
将yaml/markdown/jupyter中的课程材料转换为 naucse.python.cz JSON API。
入口点
有两个公共入口点:一个用于获取一般课程信息; 另一个是课程的一部分。
(这种分离意味着不需要呈现内容就可以获得课程 信息。)
naucse_render.get_course(course_slug, *, path='.', version=None)
naucse_render.get_lessons(lesson_slugs, vars=None, path='.')
path
指定存储库根目录的本地文件系统路径
(即courses
、runs
和lessons
的父目录)。
安装和使用
您可以从命令行运行naucse_render:
python -m naucse_render get-course courses/mi-pytpython -m naucse_render get-lessons beginners/install beginners/venv-setup
默认情况下,从当前工作目录检索数据。
使用--path
选项将naucse\u render指向其他位置。
测试
要测试,请安装pipenv
,并安装依赖项:
$ pipenv install --dev
然后运行测试:
$ pipenv run test
许可证
代码是根据mit许可的条款授权的,请参见LICENSE.MIT文件 全文。通过向这个存储库贡献代码,您就同意拥有它 在同一许可下许可。
更改日志
Naucse_渲染1.2
- API版本0.1
- 现在为会话生成序列号。
- 序列是字符串(或无)。通常是数字(比如
'1'
)。 在源yaml中,它们可以指定为int。 但是,例如,附录可以使用罗马数字:i
,ii
,iii
。 - 如果源yaml中没有显式地给出序列号,则
自动生成为前一个序列加1(或从开始处的
1
)。 指定为str(或none)的序列会阻止此自动生成。 - 对于只有一个会话的课程,序列号不是自动生成的。
- 序列是字符串(或无)。通常是数字(比如
Naucse_渲染1.1
- 使在课程内容中使用来自yaml文件的数据成为可能
- 使Windows上的输出与“Unixy”系统上的相同
Naucse_渲染1.0
- 源文件始终报告为相对路径
- yaml文件更改后将重新加载
- 添加集成测试
Naucse_渲染0.x
0.x应该成功地呈现naucse.python.cz上托管的课程 2019年之前。
源文件的格式是有组织地增长的,因此这里没有尝试 记录下来。