将课程材料转换为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指定存储库根目录的本地文件系统路径 (即coursesrunslessons的父目录)。

安装和使用

您可以从命令行运行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。 但是,例如,附录可以使用罗马数字:iiiiii
    • 如果源yaml中没有显式地给出序列号,则 自动生成为前一个序列加1(或从开始处的1)。 指定为str(或none)的序列会阻止此自动生成。
    • 对于只有一个会话的课程,序列号不是自动生成的。

Naucse_渲染1.1

  • 使在课程内容中使用来自yaml文件的数据成为可能
  • 使Windows上的输出与“Unixy”系统上的相同

Naucse_渲染1.0

  • 源文件始终报告为相对路径
  • yaml文件更改后将重新加载
  • 添加集成测试

Naucse_渲染0.x

0.x应该成功地呈现naucse.python.cz上托管的课程 2019年之前。

源文件的格式是有组织地增长的,因此这里没有尝试 记录下来。

欢迎加入QQ群-->: 979659372 Python中文网_新手群

推荐PyPI第三方库


热门话题
java通过Spring MVC web应用程序向客户端发送文本文件   java是否可以在运行时动态实例化DAO类?   调用VB。来自Java的net函数   java在Android中通过单击打开特定文件夹   java如何使用maven pom。xml标识非标准项目结构中的testng测试用例?   java为什么FOP在大文件上崩溃?   Architecture python+flask和spring boot+java   java Kafka工具根本没有启动Ubuntu 19.10   如何使用Eclipse运行Java USB API for Windows   java如何在Eclipse中查看J2EE预览服务器/容器的日志/控制台?   网页抓取是否可以使用Java crawler crawler4j暂停和恢复抓取?   java当我第二次按下按钮时,应用程序停止工作   带有偏移量和限制的java SQLite分页问题   java如何在OSX mavericks中将端口80转发到8080   java从泛型方法调用非泛型方法   java My代码未按预期工作。十进制输出不是它应该的样子   节点。java中的js加密(jasypt)和nodejs中的解密   java乘法表不工作数组索引超出范围   java将JDBC与Firebirdsql连接起来