Omahub
← All plugins
C

Omacanvas

by Christopher Haynes

Student grades and teacher assignment deadlines from Canvas in the Omarchy bar.

GitHub

Security review

No obvious issues detected

Deterministic scan — not a security guarantee

None
Risk level
None
Analyzed commit
24bafea
Scanned
1 month ago

No potentially dangerous behavior detected in the analyzed commit.

Automated analysis only — not a security guarantee.

AI advisory review

No obvious issues detected

Language-model assessment · ~deepseek/deepseek-v4-flash-latest — advisory only

Low
AI risk level
Low
Recommendation
install
Model
~deepseek/deepseek-v4-flash-latest
Analyzed commit
24bafea
Reviewed
1 month ago

The plugin is a well-structured Canvas LMS widget with proper security practices: it validates URLs to prevent cross-origin requests, sanitizes text, stores API tokens in the system keyring, and uses secure file handling for hidden-course preferences. No malicious or suspicious code was found in the sampled files.

How this check works

This review combines the deterministic scan (the rule-based results above) with an independent look at the plugin's code by a language model. The model reads a trimmed sample of the repository's files, the manifest, and the README, then gives a plain-language risk level and a recommendation: install (no notable danger), review (look closer first), or avoid (clearly dangerous).

It runs on the same analyzed commit as the deterministic scan and is strictly advisory — it is not a security guarantee and never blocks a plugin by itself. A human moderator still reviews plugins before they are listed.

AI advisory only — automated analysis, not a security guarantee.

Install
$ omarchy plugin add https://github.com/christopherhaynes33/omacanvas --enable
Productivity #bar #quickshell

Omacanvas

Omacanvas is a native Omarchy Quickshell bar widget for Canvas LMS. It shows current grades and assignments due soon for students, plus upcoming assignment deadlines and grading counts for teachers. Accounts with both roles can switch between Student and Teaching views.

Omacanvas is an independent community project and is not affiliated with, endorsed by, or sponsored by Instructure or Canvas LMS.

Omacanvas Student Assignments, Teaching Overview, and Teaching Courses views

The panel provides three views:

  • Overview — assignment and course summaries, plus grades or grading counts.
  • Assignments — student work or teaching deadlines during the configured window.
  • Courses — per-course details, assignments, links, and visibility controls.

Requirements

  • A current Omarchy installation using the standard Quickshell bar.
  • Python 3.10 or newer.
  • secret-tool, provided by the libsecret package, for secure token storage.
  • A Canvas account permitted to create personal access tokens.

Install the keyring tool if it is not already available:

omarchy pkg add libsecret

Install

Install directly from the public GitHub repository and enable the widget:

omarchy plugin add https://github.com/christopherhaynes33/omacanvas.git --enable

Choose a bar section when prompted. The default section is the right side.

Configure Canvas

Omacanvas needs the HTTPS base URL of the Canvas installation and a personal access token. The URL is stored in Omarchy's normal widget settings. The token is stored in the system keyring and is scoped to that URL, so separate Canvas installations can use separate tokens.

1. Find the Canvas base URL

Open Canvas in a browser and copy only the origin from the address bar. Do not include a course or assignment path. Omacanvas accepts HTTPS URLs only.

For example, if a course URL is:

https://canvas.example.edu/courses/12345

the base URL is:

https://canvas.example.edu

Set it from Setup → Plugins → Omacanvas, or from a terminal:

omarchy bar set io.github.christopherhaynes33.omacanvas baseUrl https://canvas.example.edu

2. Create a Canvas API token

[!IMPORTANT] Instructure documents manual token generation as a testing workflow and requires OAuth for applications used by multiple users. Omacanvas currently supports personal access tokens, not OAuth. Before using one, confirm that your institution permits a manually generated token for a local, personal client. See the Canvas OAuth2 documentation.

In Canvas:

  1. Open Account → Settings.
  2. Find Approved Integrations.
  3. Select New Access Token.
  4. Enter a purpose such as Omacanvas and, if desired, an expiration date.
  5. Select Generate Token.
  6. Copy the token immediately. Canvas normally displays the complete token only once.

Some institutions disable personal access tokens. If New Access Token is not available, contact the institution's Canvas administrator.

Treat the token like a password.

3. Save the token in the keyring

Run the installed helper and enter the token at the hidden prompt:

~/.config/omarchy/plugins/io.github.christopherhaynes33.omacanvas/omacanvas set-token \
  --base-url https://canvas.example.edu

The URL must match the configured base URL after trailing slashes are removed. Setting a token again replaces the saved token for that Canvas installation.

Right-click the Omacanvas bar icon after configuration to refresh immediately.

Use the widget

  • Left-click the bar icon to open or close the panel.
  • Right-click the bar icon to refresh Canvas data manually.
  • When both roles are available, select the STUDENT or TEACHING label at the right side of the header to toggle roles.
  • Select Overview, Assignments, or Courses at the top of the panel.
  • Select an assignment name to open it in Canvas.
  • Select a course name to open its Canvas landing page.
  • Press 1, 2, or 3 to select a view while the panel is focused.
  • Press S or T to select Student or Teaching while the panel is focused.
  • Press Left/Right to change views and Up/Down to scroll.
  • Press R or Enter to refresh, and Escape to close the panel.

The widget refreshes every six hours by default and shows assignments due in the next 14 days.

Assignment status and availability

Student assignments use one compact status icon:

  • No icon means the assignment is open and not submitted.
  • A checkmark means Canvas reports the assignment as submitted.
  • A lock means Canvas reports the assignment as locked for the current user.

On the student Assignments and Courses views, submitted assignments are grouped under a collapsed disclosure below the open assignments. Select the disclosure to review them; its expanded or collapsed state is shared between the two views until the panel is closed. Teaching assignments are not grouped this way. The Overview's Next line also skips submitted student work.

Locked student assignments show their future unlock date when Canvas provides one. If Canvas reports the assignment as locked without a future unlock date, Omacanvas displays Locked · No scheduled unlock date. Lock and submission states are informational; selecting the assignment still opens its Canvas URL when one is available.

Teaching view

Teaching displays active courses in which Canvas reports a teacher enrollment. It shows upcoming assignment deadlines, Published or Draft assignment status, course Published or Unpublished status, and the course's total number of submissions needing grading. A lock marks an assignment with a future scheduled unlock. Assignments with differentiated dates show the number of availability schedules and, when applicable, the earliest upcoming unlock. The teacher view is read-only and does not retrieve individual submissions.

Hide or restore a course

In Courses, use the eye-slash action to hide the selected course. Hidden courses are excluded from assignment counts, alerts, and assignment API requests in both roles. Expand the muted hidden-course row and use the eye action to restore a course.

Course visibility is stored per Canvas installation in:

${XDG_CONFIG_HOME:-~/.config}/omacanvas/hidden-courses.json

Settings

Settings are available under Setup → Plugins → Omacanvas or through omarchy bar set:

# Change the assignment window to 21 days.
omarchy bar set io.github.christopherhaynes33.omacanvas days 21 --json

# Change automatic refresh to every three hours.
omarchy bar set io.github.christopherhaynes33.omacanvas refreshIntervalSec 10800 --json

# Change Canvas installations. Save a token for the new URL separately.
omarchy bar set io.github.christopherhaynes33.omacanvas baseUrl https://other.example.edu

The assignment window accepts 1–60 days. The refresh interval accepts 300–86400 seconds.

Manage API tokens

Replace or add a token:

~/.config/omarchy/plugins/io.github.christopherhaynes33.omacanvas/omacanvas set-token \
  --base-url https://canvas.example.edu

Remove the token for one Canvas installation:

~/.config/omarchy/plugins/io.github.christopherhaynes33.omacanvas/omacanvas clear-token \
  --base-url https://canvas.example.edu

For temporary terminal use, explicitly select CANVAS_API_KEY instead of the keyring. It is not written to disk and never overrides URL-scoped credentials unless --token-from-env is present:

CANVAS_API_KEY='your-token' \
  ~/.config/omarchy/plugins/io.github.christopherhaynes33.omacanvas/omacanvas fetch \
  --token-from-env --base-url https://canvas.example.edu

Avoid placing a real token in shell history. Prefer the interactive set-token command for normal use.

Terminal commands

The helper can also be run independently:

OMACANVAS=~/.config/omarchy/plugins/io.github.christopherhaynes33.omacanvas/omacanvas

$OMACANVAS fetch --base-url https://canvas.example.edu
$OMACANVAS fetch --json --base-url https://canvas.example.edu
$OMACANVAS set-token --base-url https://canvas.example.edu
$OMACANVAS clear-token --base-url https://canvas.example.edu
$OMACANVAS hide-course COURSE_ID --base-url https://canvas.example.edu \
  --course-name 'Orientation' --course-code 'ORIENT'
$OMACANVAS unhide-course COURSE_ID --base-url https://canvas.example.edu

Human-readable fetch output is divided into Student and Teaching sections. With --json, both role payloads are returned under roles. The hide and unhide commands are normally easier to use from the Courses view.

Update, disable, or remove

Update the Git-managed plugin:

omarchy plugin update io.github.christopherhaynes33.omacanvas

Disable or re-enable the widget:

omarchy plugin disable io.github.christopherhaynes33.omacanvas
omarchy plugin enable io.github.christopherhaynes33.omacanvas --section right

Remove the plugin:

omarchy plugin remove io.github.christopherhaynes33.omacanvas

Removing the plugin does not remove tokens from the system keyring or the hidden-course preferences. Use clear-token before removal and delete the Omacanvas configuration directory manually if those should also be removed.

Privacy and permissions

Omacanvas sends authenticated HTTPS requests only to the configured Canvas installation. It requests active student and teacher enrollments, student scores/grades and submission status, teacher grading counts, course publication status, and assignments due within the selected window. Assignment data includes publication status and Canvas availability dates needed to display lock and unlock information. Teacher data is read-only; Omacanvas does not retrieve individual submissions or change grades. Hidden courses skip assignment requests. The token is read from the desktop keyring and is never written to Omarchy's plain-text configuration. Assignment and course links are opened in the default browser only after Omacanvas verifies that they use the configured Canvas origin; the API token is not included in browser links.

Like every Omarchy shell plugin, Omacanvas runs as user code inside the shell. Review third-party plugin source before installation.

Troubleshooting

  • “Set your Canvas URL” — configure baseUrl using the command above or Setup → Plugins → Omacanvas.
  • “No Canvas API token is saved” — run set-token with the exact same base URL configured for the widget.
  • secret-tool is missing — install libsecret with omarchy pkg add libsecret.
  • Canvas rejected the API token — create a new token in Canvas and run set-token again.
  • The API-token option is missing in Canvas — the institution may prohibit personal tokens; ask its Canvas administrator.
  • A course is missing — Omacanvas displays active student and teacher enrollments. Check the selected role and hidden-courses disclosure.
  • The Student/Teaching toggle is missing — the role label appears only when Canvas returns both active student and teacher roles. Accounts with one role open directly in that view.
  • A lock or unlock date looks stale — right-click the bar icon to refresh; automatic refresh occurs every six hours by default.
  • Changes do not appear — right-click the icon, then run omarchy restart shell if needed.

Local development

From a checkout of this repository:

omarchy plugin validate .
python3 -m unittest discover -s tests
omarchy plugin add "$(pwd)" --enable

The helper uses only Python's standard library.

License

Omacanvas is released under the MIT License. See LICENSE.