Skip to content
This repository has been archived by the owner on Sep 4, 2023. It is now read-only.

How to use

Jelle Maas edited this page Nov 8, 2022 · 9 revisions

Installation

Download

The first step is to download the latest release for your operating system from the releases page. This download contains a ZIP archive which holds all the necessary dependencies and executables, including a sample for the configuration file.

Canvas

Access

To fetch data from Canvas, we need an access token. This access token has to be created for your profile, and acts as a second password into your account. Go to https://fhict.instructure.com/profile/settings, navigate to “Approved Integrations” and generate a new access token.

Canvas access token generation

After that, copy the access token and paste it in the appsettings.json file, under the Canvas.AccessToken setting.

Course

To identify your course, we require the course identifier. To find your course identifier, navigate to your personal course in Canvas. The identifier of your personal course can be found in the URL.

Canvas personal identifier URL

For example, https://fhict.instructure.com/courses/00001, in this case 00001 is your personal course identifier. Paste this identifier in the appsettings.json file, under the Canvas.CourseId setting.

Export

Currently, Epsilon is limited to command line interface (CLI) only. However, in the future, we want to create a user-friendly web interface to do most of the work for you! To export your learning outcomes, you must execute the Epsilon.Cli, executable within a command prompt. This executable can be found in the ZIP archive downloaded from earlier.

Windows

.\Epsilon.Cli.exe --formats csv,console

macOS and Linux

To be able to run the executable on macOS and Linux, you have to set the execution rights properly. This can be done with the following command:

chmod +x Epsilon.Cli

After which, the executable can be run like any other executable:

./Epsilon.Cli --formats csv,console
Clone this wiki locally