Skip to content

Version 2 of https://github.com/Harvard-ATG/AcademicIntegrityTool. Upgrades include architectural navigation improvements, UI changes to make the interfaces consistent with the Canvas UI, and rewriting the tool itself in Python/Django (as opposed to Ruby). The tool will be deployed to the TLT environment.

Notifications You must be signed in to change notification settings

Harvard-ATG/academic_integrity_tool_v2

Repository files navigation

Coverage Status

AI Policy Tool (V2) (Formerly Academic Integrity Policy Tool)

This is a django application that enables instructors to prepare AI policies from templates made by instructional technologists and publish said policies for students to view. It is an LTI tool that is embedded into and launched from the Canvas LMS.

Installing the tool in the Canvas LMS

Follow the Canvas Admin Guide on How do I configure an external app for an account using XML?. This can be done at either the sub-account level or in a specific canvas course by visiting that course's settings.

The key details you will need include:

  • Consumer key: obtain this from academic_integrity_tool_v2/settings/secure.py
  • Shared secret: obtain this from academic_integrity_tool_v2/settings/secure.py
  • XML configuration: obtain this from http://localhost:8000/lti/config

Once installed, the tool should be displayed in the left-hand course navigation as AI Policy. Note that it may be disabled in the navigation by default, so you may need to manually enable it in the course settings navigation (drag and drop to move to the desired position).

Developer Notes

The instructions below assume you have Docker installed on your machine.

Getting setup

Configure django settings:

$ cp academic_integrity_tool_v2/settings/secure.py.example academic_integrity_tool_v2/settings/secure.py
$ echo 'SECURE_SETTINGS["db_default_host"] = "db" # for docker' >> academic_integrity_tool_v2/settings/secure.py
$ echo 'SECURE_SETTINGS["redis_host"] = "redis" # for docker' >> academic_integrity_tool_v2/settings/secure.py

Run the application:

$ docker compose up
$ docker compose run web python manage.py migrate
$ docker compose run web python manage.py loaddata --app policy_wizard boilerplate_policy_templates.yml

Open the tool in your web browser to verify it is up and running:

open http://localhost:8000

Testing

$ docker compose run web python manage.py test

Update the Coverage Badge

$ coverage run --source='.' manage.py test
$ coverage-badge -f -o coverage.svg
  • Then commit and push the changes!

Resources

Original demos

These are demos of the original academic integrity tool and are slightly out of date, but preserved for reference.

About

Version 2 of https://github.com/Harvard-ATG/AcademicIntegrityTool. Upgrades include architectural navigation improvements, UI changes to make the interfaces consistent with the Canvas UI, and rewriting the tool itself in Python/Django (as opposed to Ruby). The tool will be deployed to the TLT environment.

Resources

Stars

Watchers

Forks

Packages

No packages published

Contributors 7