nbgrader 项目教程

nbgrader 项目教程

nbgraderA system for assigning and grading notebooks项目地址:https://gitcode.com/gh_mirrors/nb/nbgrader

1. 项目的目录结构及介绍

nbgrader 是一个用于创建和评分 Jupyter Notebook 作业的工具。以下是其主要目录结构的介绍：

nbgrader/
├── nbgrader/
│   ├── auth/
│   ├── build/
│   ├── commands/
│   ├── converters/
│   ├── exchange/
│   ├── forms/
│   ├── gradebook/
│   ├── nbextensions/
│   ├── server_extensions/
│   ├── tests/
│   ├── utils/
│   ├── validate_assignment.py
│   ├── __init__.py
│   └── ...
├── docs/
├── etc/
├── examples/
├── nbgrader/
├── scripts/
├── setup.py
└── ...

• nbgrader/: 包含 nbgrader 的核心代码。
  • auth/: 认证相关模块。
  • build/: 构建相关模块。
  • commands/: 命令行工具相关模块。
  • converters/: 转换器相关模块。
  • exchange/: 交换服务相关模块。
  • forms/: 表单相关模块。
  • gradebook/: 成绩簿相关模块。
  • nbextensions/: Jupyter Notebook 扩展相关模块。
  • server_extensions/: 服务器扩展相关模块。
  • tests/: 测试相关模块。
  • utils/: 工具函数相关模块。
  • validate_assignment.py: 验证作业的脚本。
  • __init__.py: 初始化文件。
• docs/: 文档目录。
• etc/: 配置文件目录。
• examples/: 示例目录。
• scripts/: 脚本目录。
• setup.py: 安装脚本。

2. 项目的启动文件介绍

nbgrader 的启动文件主要是 nbgrader/nbgrader/nbgraderapp.py，它定义了 nbgrader 的主要应用程序类 NbGraderApp，负责启动和管理 nbgrader 的各种功能。

from traitlets.config.application import Application
from . import __version__

class NbGraderApp(Application):
    name = 'nbgrader'
    description = 'A system for assigning and grading notebooks'
    version = __version__
    ...

3. 项目的配置文件介绍

nbgrader 的配置文件是 nbgrader_config.py，它通常位于项目的根目录或 Jupyter 配置目录中。以下是一些常见的配置选项：

c = get_config()

# 配置交换服务的目录
c.Exchange.root = '/path/to/exchange'

# 配置自动评分选项
c.Autograde.execute = True
c.Autograde.timeout = 120

# 配置学生版本的外观
c.AssignLatePenalties.penalty_per_day = 10
c.AssignLatePenalties.max_penalty = 50

配置文件中可以设置各种选项，包括交换服务的目录、自动评分选项、学生版本的外观等。详细的配置选项可以参考官方文档。

nbgraderA system for assigning and grading notebooks项目地址:https://gitcode.com/gh_mirrors/nb/nbgrader