Complete the steps described in the rest of this page to create a simple Python command-line application that makes requests to the Classroom API.
To run this quickstart, you'll need:
- Python 2.6 or greater
- The pip package management tool
- A G Suite for Education account with Google Classroom enabled
Step 1: Turn on the Classroom API
Click this button to create a new console project and automatically enable the Classroom API:
This opens a new dialog. In the dialog, do the following:
- Select + Create a new project.
- Download the configuration file.
- Move the downloaded file to your working directory and ensure it is named
Step 2: Install the Google Client Library
Run the following command to install the library using pip:
pip install --upgrade google-api-python-client google-auth-httplib2 google-auth-oauthlib
See the library's installation page for the alternative installation options.
Step 3: Set up the sample
Create a file named
quickstart.py in your working directory and copy in the
from __future__ import print_function import pickle import os.path from googleapiclient.discovery import build from google_auth_oauthlib.flow import InstalledAppFlow from google.auth.transport.requests import Request # If modifying these scopes, delete the file token.pickle. SCOPES = ['https://www.googleapis.com/auth/classroom.courses.readonly'] def main(): """Shows basic usage of the Classroom API. Prints the names of the first 10 courses the user has access to. """ creds = None # The file token.pickle stores the user's access and refresh tokens, and is # created automatically when the authorization flow completes for the first # time. if os.path.exists('token.pickle'): with open('token.pickle', 'rb') as token: creds = pickle.load(token) # If there are no (valid) credentials available, let the user log in. if not creds or not creds.valid: if creds and creds.expired and creds.refresh_token: creds.refresh(Request()) else: flow = InstalledAppFlow.from_client_secrets_file( 'credentials.json', SCOPES) creds = flow.run_local_server() # Save the credentials for the next run with open('token.pickle', 'wb') as token: pickle.dump(creds, token) service = build('classroom', 'v1', credentials=creds) # Call the Classroom API results = service.courses().list(pageSize=10).execute() courses = results.get('courses', ) if not courses: print('No courses found.') else: print('Courses:') for course in courses: print(course['name']) if __name__ == '__main__': main()
Step 4: Run the sample
Run the sample using the following command:
The sample will attempt to open a new window or tab in your default browser. If this fails, copy the URL from the console and manually open it in your browser.
If you are not already logged into your Google account, you will be prompted to log in. If you are logged into multiple Google accounts, you will be asked to select one account to use for the authorization.
- Click the Accept button.
- The sample will proceed automatically, and you may close the window/tab.
- Authorization information is stored on the file system, so subsequent executions will not prompt for authorization.
- The authorization flow in this example is designed for a command-line application. For information on how to perform authorization in a web application, see Using OAuth 2.0 for Web Server Applications.
- Google Developers Console help documentation
- Google APIs Client for Python documentation
- Classroom API PyDoc documentation
- Classroom API reference documentation
AttributeError: 'Module_six_moves_urllib_parse' object has no attribute 'urlparse'
This error can occur in Mac OSX where the default installation of the
module (a dependency of this library) is loaded before the one that pip
installed. To fix the issue, add pip's install location to the
system environment variable:
Determine pip's install location with the following command:
pip show six | grep "Location:" | cut -d " " -f2
Add the following line to your
<pip_install_path>with the value determined above:
~/.bashrcfile in any open terminal windows using the following command:
TypeError: sequence item 0: expected str instance, bytes found
This error is due to a bug in
httplib2, and upgrading to the latest version
should resolve it:
pip install --upgrade httplib2
Cannot uninstall 'six'. It is a distutils installed project...
When running the
pip install command you may receive the following error:
Cannot uninstall 'six'. It is a distutils installed project and thus we cannot accurately determine which files belong to it which would lead to only a partial uninstall.
This can happen on Mac OSX when pip attempts to upgrade the
six package that
came pre-installed. To work around this issue you can add the flag
--ignore-installed six to the
pip install command listed in Step 2.