Skip to content

INSTALLATION.md

Latest commit

 

History

History
99 lines (82 loc) · 4.01 KB

INSTALLATION.md

File metadata and controls

99 lines (82 loc) · 4.01 KB

Step-by-Step Guide to Get Google Calendar API Credentials

1️⃣ Create a Google Cloud Project

  1. Go to the Google Cloud Console.
  2. Click on the project dropdown (top-left) → New Project.
  3. Enter a Project Name (e.g., "WhatsApp Bot Calendar").
  4. Click Create.

2️⃣ Enable Google Calendar API

  1. Inside your new project, go to the Google API Library.
  2. Search for Google Calendar API.
  3. Click Enable.

3️⃣ Create Service Account (For API Access)

  1. Open Service Accounts.
  2. Click Create Service Account.
  3. Service Account Name: Give it a name (e.g., "Calendar Bot").
  4. Click Create and Continue.
  5. Grant Role: Select Editor or Owner (or Cloud Functions Invoker for limited access).
  6. Click Done.

4️⃣ Generate API Credentials (JSON File)

  1. In the Service Accounts section, find your newly created service account.
  2. Click on it → Keys tab → Add Key → Create New Key.
  3. Choose JSON, then click Create.
  4. A JSON file will download. Keep it safe—this is your credential file!

5️⃣ Share Google Calendar with Service Account

  1. Go to Google Calendar.
  2. Click on Settings (⚙️) → Settings.
  3. Scroll to "My Calendars" and select the calendar you want to use.
  4. Under "Share with specific people", click Add people.
  5. Enter the service account email (found in your JSON file).
  6. Set permissions to "Make changes to events".
  7. Click Send.

6️⃣ Store Credentials in Your Python Project

  1. Open your .env file (or create one).

  2. Add the following variables:

    GOOGLE_CALENDAR_CREDENTIALS='PASTE_YOUR_JSON_HERE'
GOOGLE_CALENDAR_ID='your_calendar_id@gmail.com'

    ⚠️ Important — format details:

    • The JSON must be a single line (no literal newlines).
    • The private key section must have its newlines escaped as \\n.
    • You can use a tool like jq or Python to minify your service account JSON.

    Example .env entry:

    GOOGLE_CALENDAR_CREDENTIALS='{"type":"service_account","project_id":"your-project-id","private_key_id":"abc123","private_key":"-----BEGIN PRIVATE KEY-----\\nMIIEv...\\n-----END PRIVATE KEY-----\\n","client_email":"your-service-account@project.iam.gserviceaccount.com","client_id":"1234567890","auth_uri":"https://accounts.google.com/o/oauth2/auth","token_uri":"https://oauth2.googleapis.com/token","auth_provider_x509_cert_url":"https://www.googleapis.com/oauth2/v1/certs","client_x509_cert_url":"https://www.googleapis.com/robot/v1/metadata/x509/your-service-account.iam.gserviceaccount.com"}'

    Quick conversion commands:

    Using jq (Linux/macOS):

    jq -c . service_account.json

    Using Python (cross-platform):

    python -c "import json;print(json.dumps(json.load(open('service_account.json'))))"
    • To find your GOOGLE_CALENDAR_ID:
      Go to Google Calendar → Settings → Integrate Calendar → copy the Calendar ID (it looks like an email).

7️⃣ Install Google API Client in Python

Run the following command to install the required library:

pip install google-auth google-auth-oauthlib google-auth-httplib2 google-api-python-client

8️⃣ Use the Credentials in Your Code

Now, update your Python code to use the credentials:

from google.oauth2 import service_account
from googleapiclient.discovery import build
import os
import json

# Load credentials
creds_json = json.loads(os.getenv("GOOGLE_CALENDAR_CREDENTIALS"))
credentials = service_account.Credentials.from_service_account_info(creds_json, scopes=["https://www.googleapis.com/auth/calendar"])

# Build the Google Calendar service
service = build("calendar", "v3", credentials=credentials)