Each Script will call the canvas api and print out a small report on all the courses the user has access to using the /api/v1/courses endpoint.
The three scripts highlight some basic ways to use the Canvas API.
simple_input.py will request the Canvas access token as user input (as a password) along with course state as an input.
simple_env.py will load data from the .env file into environment variables for Canvas access token, course state, per page, and the canvas base url. It will quit if no access token is provided or if course state is not provided or valid (per page and base url will use default values if not found).
robust.py uses the Click library to check environment variables and take in user input. It also uses the canvasapi library to wrap around the Canvas api. This implementation is a bit more robust in that it uses the power of existing libraries to simplify the code.
You must rather have Python installed on your system or Docker.
You can use Docker to skip the python dependency. To setup an environment to run the example scripts, just run:
docker-compose run test bash
cd /code && pip install requirements.txt
if you aren't using docker, make sure to install the pip requirements with
pip install requirements.txt
From here both Python and Docker will run the scripts the same
Run the script with
python simple_input.py
Setup the variables to be loaded as environment variables by creating a file .env with these contents
export CANVAS_ACCESS_TOKEN=########
export CANVAS_COURSE_STATE=available
export CANVAS_URL=https://canvas.ubc.ca
export CANVAS_PER_PAGE=40
Run the script with
python simple_env.py
Setup the variables to be loaded as environment variables by creating a file .env with these contents
export CANVAS_ACCESS_TOKEN=########
export CANVAS_COURSE_STATE=available
export CANVAS_URL=https://canvas.ubc.ca
export CANVAS_PER_PAGE=40
Run the script with
python robust.py
You can also pass variables (except for the token) from the command line, instead of storing them in a .env file.
python robust.py --url=https://canvas.ubc.ca --per_page=40 --state=available