Canvas Gamification

Contents

• 1   Main Features
• 2   Getting Started
  • 2.1   Dependencies
  • 2.2   Installing
    • 2.2.1   Install Using Pip
    • 2.2.2   Install From Local
• 3   Usage
  • 3.1   Examples
  • 3.2   Tests
• 4   Authors

1   Main Features

2   Getting Started

2.1   Dependencies

Python 3.7

Required Packages

• canvasapi
• click

2.2   Installing

2.2.1   Install Using Pip

pip install canvas-gamification

2.2.2   Install From Local

1. Activate the provided virtualenv in ./venv or create your own virtual env

2. Install the program using this command line:

   pip install --editable .

3   Usage

Copy the settings.sample.json to settings.json and fill/change the parameters accordingly.

pass the name of the setting file as --settings. see the examples.

3.1   Examples

• gamification --help
• gamification --settings settings.json assign-weights

3.2   Tests

Tests are available in /test folder.

run all the tests by

• python -m unittest

4   Authors

Keyvan Khademi

• Email: keyvankhademi@gmail.com
• GitHub: keyvankhademi

Angie Pinchbeck

• Email: angie.pinchbeck@gmail.com
• GitHub: apinchbeck
• LinkedIn: Angie Pinchbeck
• Google Scholar: Angie Pinchbeck