naucse

这是一个开放课程材料的服务器。

要使用它，您需要一些内容。通常，包含内容的仓库将需要naucse模块，并使用python -m naucse运行。

我们使用https://github.com/pyvec/naucse.python.cz中的内容来生成naucse.python.cz。

安装

从虚拟环境中安装。

要安装最新版本

(venv)$ python -m pip install naucse

要从克隆的仓库安装，用于开发

(venv)$ python -m pip install -e.[dev]

运行

要运行服务器，要么更改（cd）到包含内容的目录，或将NAUCSE_ROOT_PATH设置为该目录。然后运行

(venv)$ python -m naucse serve

您可以用freeze代替serve来生成静态网站。有关其他用法（包括部署到GitHub Pages）的信息，请参阅Elsa。

提供的服务课程

提供的服务网站上的课程来自两个来源

• courses.yml在$NAUCSE_ROOT_PATH中，条目如下

    course_slug:
        url: https://github.com/user/repo
        branch: main
        path: _compiled
  

  将克隆指定的存储库。在指定的路径和分支中，naucse期望由python -m naucse_render compile准备的编译课程信息。

  这适用于生产网站，它聚合了大量单独的课程。

  如果存在courses.yml，naucse将使用一个美观的首页（而不是在首页上列出所有课程）。

• 通过python -m naucse_render ls找到的任何课程。这在本地开发课程时很有用。

测试

可以使用tox运行测试

(venv)$ tox

或直接使用pytest

(venv)$ python -m pytest

许可证

本代码遵循MIT许可协议，请参阅LICENSE.MIT文件获取完整内容。通过向此仓库贡献代码，您同意其以相同的许可协议进行许可。

内容在其适当的元数据中指定了相应的许可。仅使用免费内容许可。通过向已授权的文档贡献，您同意其以相同的许可协议进行许可。（并且您可以自由地将其添加到其元数据中的作者列表。）当贡献新文档时，必须在元数据中指定许可。