Time planner

Author: Marco Gutierrez

Description

The idea of this project was to showcase a practical example of Object-Oriented programming applied to a common activity at work. This script creates a spreadsheet with time spent per project using Google mail and calendar data following the IADB format.

Prerequisites

1. Python 3.x. Download link here
2. Check requirements.txt for Python package requirements

Setup Instructions

0. Download the script

---

1. Download the latest one by clicking on Assets > Source code (zip)
2. Unpack the files on the folder of your preference
3. Install the requirements
   1. Install Python
   2. Install required packages
      1. Open a console
         1. On Windows, click on the Windows Icon, search for cmd and open it
         2. On Mac/Ubuntu, search for terminal and open it
      2. Copy the path where you downloaded the script (e.g. D:\Archivos de programa\folder_with_script)
      3. Use this command on the console with the path where you downloaded the Script: cd "D:\Archivos de programa\folder_with_script"
      4. Run pip install -r requirements.txt

1. Create a new Google Cloud Platform (GCP) project

---

To use Google Workspace APIs, you need a Google Cloud Platform project. This project forms the basis for creating, enabling, and using all GCP services, including managing APIs, enabling billing, adding and removing collaborators, and managing permissions.

1. Open the Google Cloud Console.
2. Next to "Google Cloud Platform," click the Down arrow arrow_drop_down . A dialog listing current projects appears.
3. Click New Project. The New Project screen appears.
4. In the Project Name field, enter a descriptive name for your project.
5. Click Organization and select your organization.
6. In the Location field, click Browse to display potential locations for your project.
7. Click a location and click Select.
8. Click Create. The console navigates to the Dashboard page and your project is created within a few minutes.

2. Enable a Google Workspace API

---

1. Open the Google Cloud Console.
2. Next to "Google Cloud Platform," click the Down arrow arrow_drop_down and select a project.
3. In the top-left corner, click Menu menu > APIs & Services.
4. Click Enable APIs and Services. The Welcome to API Library page appears.
5. In the search field, enter the name of the API you want to enable. In this case, "Calendar API" to find the Google Calendar API.
6. Click the API to enable. The API page appears.
7. Click Enable. The Overview page appears.

3. Obtain required crendentials for API Usage

---

1. Open the Google Cloud Console.
2. Next to "Google Cloud Platform," click the Down arrow arrow_drop_down and select a project.
3. In the top-left corner, click Menu menu > APIs & Services > Credentials.
4. Click on "+ Create credentials" on the top menu and select OAuth client ID
5. On Application type, select Web Application
6. Choose a name of your preference and click on Create
7. The credentials page will appear again. Search for your newly created credentials in the OAuth 2.0 Client IDs
8. Click on the Download icon at the right of your credentials name
9. Change it's name to credentials and store it on the same folder where you downloaded this script

4. Run the script

---

1. Install the prerequisites
2. Open a console
   1. On Windows, click on the Windows Icon, search for cmd and open it
   2. On Mac/Ubuntu, search for terminal and open it
3. Copy the path where you downloaded the script (e.g. D:\Archivos de programa\folder_with_script)
4. Use this command on the console with the path where you downloaded the Script: cd "D:\Archivos de programa\folder_with_script"
5. Run python time_planner.py
6. Follow the instructions given by the script