跳转到主要内容

Canvas成绩重排和审查的命令行工具

项目描述

canvascli

canvascli 从Canvas下载成绩,将其转换为UBC FSC最终提交所需的格式,并创建一些有用的可视化。

安装

canvascli 需要Python的最新版本及其包管理器 pip。安装这些之后(例如,通过 miniconda),您可以从终端运行此命令。

python -m pip install -U canvascli

用法

所有 canvascli 功能都需要您已创建 Canvas API访问令牌,如果您还没有,请先创建。

运行 canvascli 时,您可以在命令行提示时粘贴您的Canvas令牌(最好使用密码管理器,例如 KeePassXC),或者 将其存储在名为 CANVAS_PAT 的环境变量中

在命令提示符中键入 canvascli 将显示包括可用子命令在内的通用帮助信息。最常见的情况可能是准备FSC提交的最终成绩,您可以通过以下方式操作

canvascli prepare-fsc-grades --course-id 53665

这将保存一个CSV文件到当前目录,可以上传到FSC。文件应该自动正确格式化,但在UBC如何输入Canvas中的课程信息时可能会有意外变化,因此双重检查是个好主意。

canvascli 默认删除没有成绩的学生,并创建了一些有用的最终成绩和作业分数的可视化。运行 canvascli prepare-fsc-grades --help 查看所有可用选项。

如果您不知道课程的Canvas课程ID,canvascli 可以为您检查

canvascli show-courses

这将输出一个表格,显示您的API令牌可以访问的所有课程。运行 canvascli show-courses --help 查看所有可用选项。

Shell自动完成(可选,点击展开)

如果您在按下 TAB 键时希望获得子命令和选项标志的建议,您可以从 GitHub 仓库下载相应的完成文件,并在您的终端配置文件中引用它。如果您不想手动操作,可以运行以下命令之一(别忘了重启您的 shell)。

Zsh

首先确保您的 zsh 通用 shell 完成功能已启用,方法是在您的 .zshrc 文件中添加 autoload -Uz compinit && compinit;在运行下面的命令之前添加这一行非常重要。

curl -Ss https://raw.githubusercontent.com/joelostblom/canvascli/main/canvascli-complete.zsh > ~/.canvascli-complete.zsh && echo ". ~/.canvascli-complete.zsh" >> ~/.zshrc

Bash

Bash shell 完成功能需要 bash >= 4.0(特别是 macOS 默认安装了 3.x,所以请使用 zsh)。如果您在 Windows 上使用 GitBash,在下面的命令中将 .bashrc 更改为 .bash_profile,请注意,您只能在输入 cavascli 后获得 shell 完成功能,而不是 canvascli.exe

curl -Ss https://raw.githubusercontent.com/joelostblom/canvascli/main/canvascli-complete.bash > ~/.canvascli-complete.bash && echo ". ~/.canvascli-complete.bash" >> ~/.bashrc

问题和贡献

欢迎提问和贡献!最佳联系方式是 创建一个新问题或讨论。请记住,在参与此项目时遵循 行为准则

项目详情


下载文件

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

源分布

canvascli-0.7.0.tar.gz (38.9 kB 查看哈希值)

上传时间

构建分布

canvascli-0.7.0-py3-none-any.whl (20.9 kB 查看哈希值)

上传时间 Python 3

由以下赞助

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