https://github.com/ubc/getting-started-with-the-canvas-api-with-python
Super easy way to get started with the Canvas API using Python
https://github.com/ubc/getting-started-with-the-canvas-api-with-python
api canvas lms python tutorial
Last synced: 4 months ago
JSON representation
Super easy way to get started with the Canvas API using Python
- Host: GitHub
- URL: https://github.com/ubc/getting-started-with-the-canvas-api-with-python
- Owner: ubc
- License: gpl-3.0
- Created: 2019-05-08T21:19:59.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-04-05T00:30:08.000Z (over 1 year ago)
- Last Synced: 2025-04-05T19:34:12.655Z (7 months ago)
- Topics: api, canvas, lms, python, tutorial
- Language: Python
- Homepage:
- Size: 19.5 KB
- Stars: 11
- Watchers: 4
- Forks: 7
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Getting Started with the Canvas API with Python
This script will get you started with interfacing with the Canvas API using Python.
## Getting Started
These instructions will get you a copy of the script up and running on your local machine for use with Canvas and your own API tokens. This script makes a request to the Canvas API that displays basic information about your user profile.
### Prerequisites
1. **Install [Python 3.7 or greater](https://www.python.org/downloads/)**.
2. **Install [Git](https://git-scm.com/downloads)**.
### Installation and execution
*Not sure how to clone a repo? Check out this [helpful guide first!](https://codeburst.io/git-and-github-in-a-nutshell-b0a3cc06458f)*
1. Open command prompt on Mac or command line on Windows.
1. Clone this repo. `git clone https://github.com/ubccapico/getting-started-with-the-canvas-api-with-python.git`
1. Then cd into the repo. `cd getting-started-with-the-canvas-api-with-python`
1. Run the installation script. `pip install -r requirements.txt` (If you see `bash: pip: command not found`, try using `pip3 install -r requirements.txt`)
1. Generate Canvas API token and copy it to clipboard.
1. Rename the `sample.env` file to `.env`, and add your API token to `CANVAS_API_TOKEN={ADD TOKEN HERE}`.
1. Run the script. `python main.py` (If you see `bash: python: command not found`, try using `python3 main.py`). This should log your Canvas info.
### What to do from here
Try running some other scripts from [Capico](https://github.com/ubccapico).
You can also write your own code and run it! Be mindful that the API is running on the production Canvas instance - if you want to run against the Beta or Test instance, change the URL in `main.py` to `https://ubc.test.instructure.com` or `http://ubc.beta.instructure.com` and regenerate your token(s) from the Beta/Test site. *Students do not have access to Beta or Test, sorry!*
## Authors
* **Justin Lee**
https://github.com/justin0022 | justin.lee@ubc.ca
* **Andrew Gardener**
https://github.com/andrew-gardener | andrew.gardener@ubc.ca
## License
This project is licensed under the GPL 3 License.