Set Up Google Cloud Platform - shiftsayan/gradecard GitHub Wiki

Gradecard uses Google Cloud Platform to sync data from the Gradecard Sheet to the individual Student Cards. In this step we will create a Google Cloud Platform project, enable required APIs, and create credentials to use the APIs.

Note: Some institutions might turn off Google Cloud Platform for users. In this case, you will need to either contact your workspace admin or use a personal Google account.

1. Follow these steps to create a new Google Cloud Platform project. 'Gradecard University Course Semester' and gradecard-<university>-<course>-<semester> are recommended defaults for the project name and project ID.

2. Follow these steps to enable Google Sheets API and Google Drive API for your new project.

3. Follow these steps to configure the OAuth consent screen. Do not worry if you cannot make the app internal. Do not worry about adding or removing scopes. Add whoever wants to use Gradecard as test users. This will help us restrict access and use Gradecard without publishing it.

4. Follow these steps to create an OAuth client ID credential. Choose 'Desktop app' as your application type. 'Gradecard Client' is the recommended default for the client name.

5. Download your client ID and secret as JSON and store the as credentials.json in the project directory.

6. Run python auth.py and complete the authentication flow ignoring Google's safety warnings. These show up because the app has not been verified by Google.

7. For large classes, Gradecard might be making a lot of API calls in a short period of time. Follow these steps to request an increase in quota for Google Sheets API. 300 read/write requests per minute per user are recommended amounts. In your request description mention that this project is for educational purposes.