danvas

Plan first. Apply explicitly. Verify everything.

danvas is a safety-focused command-line tool built on the CanvasAPI Python client for day-to-day Canvas course operations. It helps instructors inspect courses, manage authored content, download submissions, reconcile grades, and retain evidence for consequential changes.

Status: signed release v0.22.0 is the latest public beta, not a 1.0 stability promise. This is an unofficial project. It is not affiliated with or endorsed by Instructure.

What It Does

• initializes course projects and snapshots Canvas metadata;
• audits assignments, Pages, files, and gradebook exports;
• creates and updates assignments, announcements, discussions, and Pages from local sources;
• downloads rosters, submissions, feedback material, and course files;
• plans and verifies grade, comment, feedback, quiz-import, and file-upload transactions;
• scores discussions into a private grades post-compatible plan;
• acquires verified private Classic Quiz student-analysis CSVs for local inspection;
• experimentally downloads Panopto captions through a Canvas LTI launch;
• provides workflow-rich help, offline task guides, and versioned JSON command discovery; and
• packages a portable Agent Skill with an explicit no-clobber installer.

It intentionally does not manage archival ledger or history databases.

Requirements

• Linux or macOS;
• Python 3.12, 3.13, or 3.14; and
• uv for the supported installation path.

Windows is unsupported because danvas cannot enforce its POSIX private-file permission contract there.

Install

Install the current public beta from PyPI:

uv tool install danvas-cli

For an exact Git-ref installation directly from the repository instead:

uv tool install \
  "danvas-cli @ git+https://github.com/olearydj/danvas.git@v0.22.0"

The Python distribution is named danvas-cli; the installed command and import package remain danvas. Users upgrading from 0.19.x should follow the 0.20.0 agent-interface migration. Users still on 0.18.x must first follow the 0.19.0 credential-boundary migration, and users on 0.17.x must also follow the 0.18.0 distribution migration rather than forcing one distribution over the other.

Verify the installation outside a source checkout:

uv tool list
danvas --version
danvas --help
danvas auth doctor

Five-Minute Setup

Create a user profile containing non-secret instance and credential references. The configuration file is danvas/config.toml beneath your platform-standard user configuration directory.

default_profile = "example-university"

[profiles.example-university]
api_url = "https://canvas.example.edu/"
timezone = "America/New_York"
api_key_env = "CANVAS_EXAMPLE_API_KEY"

Set the referenced token without writing it into either configuration file:

read -rs CANVAS_EXAMPLE_API_KEY
export CANVAS_EXAMPLE_API_KEY
danvas auth doctor --profile example-university --check-canvas
unset CANVAS_EXAMPLE_API_KEY

Danvas consumes the selected variable but does not own the secret store. A credential file or an external runner can also supply the token. For on-demand retrieval, a trusted user profile may configure an optional credential_command; local diagnostics do not execute it. See Authentication.

Initialize a course project. New projects materialize the standard-v1 source layout in .danvas/config.toml; they do not move or create authored files.

mkdir example-course
cd example-course
danvas init 101 --profile example-university
danvas status

Course IDs, permissions, and available endpoints come from your Canvas deployment. Danvas cannot bypass institutional policy or Canvas authorization.

Safety Model

Canvas-changing commands plan by default. Omitting both flags never authorizes a Canvas mutation:

danvas assignments update content/assignments/week-01.md
danvas assignments update content/assignments/week-01.md --apply

--dry-run is the explicit spelling for the same plan mode. Some higher-risk commands also require a command-specific --confirm value. Local-writing sync commands keep their own --dry-run behavior and never gain --apply merely for writing local sources.

Review generated evidence before applying and after any uncertain outcome. Do not blindly retry a request reported as accepted but unverified.

Private artifacts default beneath .danvas/private/ in initialized projects. On supported POSIX systems, danvas creates private directories as 0700 and files as 0600, including temporary files. It does not overwrite private artifacts by default. Outside a project, private-output commands require an explicit destination before authentication begins.

Operators remain responsible for institutional data-handling, sharing, and retention requirements.

Common Workflows

# Refresh the local course snapshot without changing Canvas.
danvas refresh --diff

# Validate authored sources without Canvas access.
danvas sources lint

# Plan and then apply one assignment update.
danvas assignments update content/assignments/week-01.md
danvas assignments update content/assignments/week-01.md --apply

# Create a private discussion-grade plan, review it, then use the grade engine.
danvas discussions score \
  https://canvas.example.edu/courses/101/discussion_topics/202 2 1 1 5
danvas grades post .danvas/private/discussions/topic-202/grade-plan.csv
danvas grades post \
  .danvas/private/discussions/topic-202/grade-plan.csv --apply

# Inspect retained report runs.
danvas reports list
danvas reports latest

# Plan an official Classic Quiz analysis report, then apply after authorization.
danvas quiz export-analysis --course-id 101 --quiz-id 202
danvas quiz export-analysis --course-id 101 --quiz-id 202 --apply
danvas quiz analysis \
  .danvas/private/quizzes/quiz-202/student-analysis.csv

Use danvas --help, group help such as danvas assignments --help, and leaf command help for the current option surface. For longer or structured discovery:

danvas guide list
danvas guide safety
danvas describe assignments update --format json
danvas skill show
danvas skill install --agent shared --dry-run
danvas skill doctor

skill install is an explicit local write, not a Canvas mutation. It installs only the version-matched bundled danvas skill at one selected allowlisted agent location. Preview first; modified or unowned targets are refused.

Documentation

• Configuration
• Authentication
• Privacy and retained artifacts
• Compatibility and support
• Authored sources
• Classic Quiz workflows
• Mutation safety
• Course policy YAML
• Related Canvas tools
• 0.18.0 migration guide
• 0.19.0 credential-boundary migration
• 0.20.0 agent-interface migration
• 0.21.0 Classic Quiz analysis-export migration
• Changelog
• Contributing
• Security policy

Sprint notes and the backlog record design history; they are not required user instructions.

Support And Community

For non-sensitive usage questions, defects, and feature requests, search the issue tracker and open an issue if the topic is not already covered. Remove tokens, student information, private course data, and protected URLs before posting. Report suspected vulnerabilities privately by following the security policy.

Contributions to documentation, tests, and bounded fixes are welcome; see the contribution guide for the development and review process.

Development

From a trusted checkout:

uv sync --frozen
uv run ruff check .
uv run ty check
uv run pytest --cov=danvas --cov-branch --cov-fail-under=82
uv run python scripts/check-docs.py
scripts/release-smoke.sh --expected-version 0.22.0

See CONTRIBUTING.md for the complete local gate, safe fixture rules, and the no-live-Canvas default.

License

MIT. See LICENSE.