OKtools

用于处理OKpy练习和解决方案的工具。

要求

• Git
• Hub工具。在Mac上 brew install hub。

有关练习标记的文档，请参阅rmdex README。

这些工具需要一个YaML格式的配置文件。以下是一个示例

# Configuration for cfd2021 exercise builds
# Save as _course.yml in home directory.

# Top-level URL for built book.
url : "https://uob-ds.github.io"
# The subpath of built book under URL.
# Full book URL will then be {url}{base_url}
baseurl : "/cfd2021"
# Local output path for exercise dirs.
# Built exercise directories / repositories will appear here.
org_path : "~/dev_trees/uob-cfd"
# Github organization name to house built repositories.
org_name : "uob-cfd"
# Git base URL for exercise dirs.
git_root : "https://github.com"
# If using JupyterHub, URL of JupyterHub instance.
# Uncomment and edit if using a JupyterHub.
# jh_root : "https://uobhub.org"

将此文件保存为_course.yml，位于练习模板所在的目录中，或在文件层次结构中较高的目录中（接近根目录）——例如，您的家目录（如果它与练习模板位于同一文件系统上）。

检查练习构建和测试的示例命令，从包含练习模板文件的目录运行

# You can omit site-config if _course.yml is in a suitable location.
okt-dir2exercise --site-config=$HOME/my_dir/_course.yml .

然后，满意后，使用--push标志将构建的练习推送到匹配的存储库

# You can omit site-config if _course.yml is in a suitable location.
okt-dir2exercise --site-config=$HOME/my_dir/_course.yml . --push