ucsdets/nbgrader-canvas-lti-oauth-flask

LTI模板：带OAUTH令牌的Flask应用

设置开发服务器

虚拟环境

• 创建虚拟环境并从requirements.txt安装依赖。

virtualenv env
source env/bin/activate
pip install -r requirements.txt

创建开发者密钥

在运行测试服务器之前，需要创建OAUTH密钥和密钥。在Instructure托管的Canvas实例上，进入账户管理页面，点击“开发者密钥”。点击“+ 开发者密钥”创建新密钥。

在弹出的对话框中，为密钥命名，并将所有者设置为您自己的地址。输入https://[my_server_url]/oauthlogin作为重定向URI。满意所有字段后，点击“保存密钥”。

您将在Canvas中看到新创建的密钥。将其状态从“关闭”切换为“开启”，以便密钥可以使用。

范围强制

创建Canvas开发者密钥时，您可以选择启用范围强制。这意味着使用从您的开发者密钥派生的密钥的用户将只能访问强制列表中列出的端点，这有利于安全性。

为此，在创建密钥时打开“强制范围”。您可以在Canvas API文档的每个API端点下方找到所需的范围，列在“范围：”之后。列出的格式正是您稍后在设置文件中需要使用的格式。

基础模板要求检查url:GET|/api/v1/users/:user_id/profile。您对Canvas API的使用可能需要更多范围。

添加服务器配置

将settings.py.template复制到项目目录中的settings.py。打开它配置以下选项：

1. 将BASE_URL设置为您的Canvas实例的URL，例如https://institution.instructure.com/。确保添加尾随斜杠！
2. 将API_URL设置为您的Canvas实例的API URL。在大多数情况下，这与BASE_URL相同。确保添加尾随斜杠！
3. 将LTI_CONSUMER_KEY和LTI_SHARED_SECRET设置为您希望的任何值。保存此信息，稍后设置LTI时会用到。
4. 在secret_key字段中输入随机字符串。此密钥用于签署会话Cookie，防止***者篡改其内容。
5. 将oauth2_id和oauth2_key分别设置为Canvas提供的ID和密钥。ID显示在开发者密钥页面的“详情”列下。密钥可以通过点击ID下方的“显示密钥”按钮查看。
6. 将oauth2_uri设置为之前为开发者密钥输入的重定向URI。

您也可以根据需要设置oauth2_scopes。它接受一个范围值列表，每个值对应您将使用获取的访问令牌访问的API端点。如果您的开发者密钥启用了范围强制，则必须将oauth2_scopes设置为一个端点列表，该列表小于或等于授予您的开发者密钥的端点。

如果您使用https://github.com/ucfopen/canvasapi%EF%BC%8C%E6%AF%8F%E4%B8%AA%E8%B0%83%E7%94%A8%E4%BD%BF%E7%94%A8%E7%9A%84%E7%AB%AF%E7%82%B9%E5%88%97%E5%9C%A8%E5%85%B6%E7%B1%BB%E5%8F%82%E8%80%83%E6%96%87%E6%A1%A3%E4%B8%AD%E3%80%82%E6%82%A8%E5%8F%AF%E4%BB%A5%E7%82%B9%E5%87%BB%E7%AB%AF%E7%82%B9%E5%88%97%E8%A1%A8%E6%9F%A5%E7%9C%8B%E8%AF%A5%E7%AB%AF%E7%82%B9%E7%9A%84%E2%80%9C%E8%8C%83%E5%9B%B4%EF%BC%9A%E2%80%9D%E5%80%BC%E3%80%82

创建数据库

• 在创建数据库之前，请根据需要修改模型！SQLAlchemy可能会使迁移变得麻烦。
• 以下是使用示例代码的方法：
• 进入项目文件夹。在Python shell中创建数据库：

    from views import db
    db.create_all()

• 如果将来想查看用户表，可以在Python shell中执行：

    from views import Users
    Users.query.all()

运行

以下是从终端运行Flask应用的方法：

export FLASK_APP=views.py
flask run

安装LTI

• 准备好XML、消费者密钥和密钥。
  • 您可以使用XML配置生成器生成XML。
• 导航到要添加LTI的课程。点击课程导航栏中的“设置”。然后，选择“应用”选项卡。在右侧选项卡附近，点击“查看应用配置”。这应该会显示课程中已有的LTI列表。点击选项卡附近的“+ 应用”按钮。
• 会弹出一个模态框，允许您自定义应用的添加方式。在“配置类型”下拉菜单中，根据您的LTI配置方式选择“按URL”或“粘贴XML”。如果您的LTI可公开访问，建议使用“按URL”。然后，填写名称和消费者密钥，以及配置URL或XML配置。点击提交。
• LTI将根据XML中的规范显示。目前，它们在extensions标签内的options标签中指定。扩展可以包括以下选项：
  • 编辑器按钮（在Canvas的任何维基页面编辑器中可见）
  • 作业提交（学生提交作业内容时）
  • 课程导航（左侧导航链接）
  • 账户导航（账户级导航）
  • 用户导航（用户个人资料）

注意：如果您使用Canvas，您的版本可能对SSL证书比较敏感。创建XML和开发项目时，请记住HTTP/HTTPS。某些浏览器会禁用非SSL的LTI内容，直到您通过点击浏览器栏中的盾牌等方式启用它。