跳转到主要内容

Kolibri插件,用于渲染可汗学院Perseus风格的练习

项目描述

这是什么?

科利布里是一款专为在低功耗设备上运行而设计的课程管理系统/学习应用程序,旨在满足基础设施有限的环境下学习者和教师的需求。更多信息请参阅learningequality.org/kolibri

珀尔修斯是可汗学院的练习题编辑器和渲染器。更多信息请参阅github.com/Khan/perseus

此软件包是珀尔修斯的包装器,允许其在科利布里中嵌入和使用。

安装

此插件包含在科利布里中 - 您很可能不需要安装它。如果您正在运行自定义版本,可以按以下方式安装

  1. 在您的科利布里虚拟环境中

    pip install kolibri-perseus-exercise-plugin
  2. 激活插件

    kolibri plugin enable kolibri_exercise_perseus_plugin
  3. 重启科利布里。

开始开发

  1. 克隆此仓库。

  2. 在您的科利布里仓库中打开终端。

  3. 运行以下命令,同时启用您的科利布里开发虚拟环境

    make clean
    pip install -e .
    pip install -e <KOLIBRI-PERSEUS-PLUGIN-LOCAL-PATH>
    kolibri plugin enable kolibri_exercise_perseus_plugin
  4. 在珀尔修斯插件仓库目录中,运行以下命令,再次使用您的 kolibri dev 虚拟环境

    cd kolibri_exercise_perseus_plugin
    yarn install
    cd ..
    make dist

更新翻译字符串

请参阅我们科利布里 i18n 文档中的说明。

发布流程和版本控制

kolibri_exercise_perseus_plugin插件的版本控制和发布独立于科利布里和珀尔修斯。我们使用语义版本控制,并为每个次要版本创建发布分支。

如何发布到 PyPi?

发布时,您需要一个 GPG 密钥来签署软件包并将其与您的身份关联。您需要在您的路径中安装 gpg。以下是一些可能有用的资源

您还需要在 PyPi 上拥有一个账户,并且可以访问kolibri-exercise-perseus-plugin 软件包

接下来,请仔细按照以下步骤操作

  1. 按照上述说明安装插件以进行开发。

  2. 运行 pip install twine

  3. kolibri_exercise_perseus_plugin/__init__.py 中更新版本号。将其提交到 perseus 发布分支。使用 github 的 Web UI 标记新版本。

  4. 检出标记的提交并确保您没有本地更改。

  5. 通过运行以下命令构建前端资源和 .whl 文件

    make dist
  6. 在 wheel 文件中搜索 kolibri_exercise_perseus_plugin 时,确保存在 CSS、JS 和 JSON 文件

    unzip -vl dist/[GENERATED WHEEL FILE NAME] | grep exercise_perseus_render_module
  7. 签名并发布到 PyPi

    make release

已知问题

开发安装版本未激活

如果您在包含 kolibri-exercise-perseus-plugin==x.x.xkolibri/requirements/base.txt 中使用 make distmake pex 运行科利布里,科利布里将在其 kolibri/dist 文件夹中生成一个 kolibri_exercise_perseus_plugin 实例并将其捆绑以供进一步分发。这意味着手动安装 kolibri_exercise_perseus_plugin 进行开发不会产生任何效果。修复此问题的方法之一是在科利布里上运行 make clean

如何贡献?

感谢您的兴趣!请参阅我们贡献部分在线开发文档

项目详情


发布历史 发布通知 | RSS 源

下载文件

下载适用于您平台的文件。如果您不确定选择哪个,请了解更多关于 安装包 的信息。

源代码分发

此版本没有可用的源代码分发文件。请参阅有关 生成分发存档 的教程。

构建分发

kolibri_exercise_perseus_plugin-1.3.5-py2.py3-none-any.whl (8.8 MB 查看哈希值)

上传时间 Python 2 Python 3

支持者

AWS AWS 云计算和安全赞助商 Datadog Datadog 监控 Fastly Fastly CDN Google Google 下载分析 Microsoft Microsoft PSF赞助商 Pingdom Pingdom 监控 Sentry Sentry 错误记录 StatusPage StatusPage 状态页面