Skip to content

Installation

Requirements

  • Python 3.11–3.14
  • pip or uv (recommended)

Install

pip install googlekit

Or with UV:

uv add googlekit

This installs GoogleKit plus the Google API client libraries used by Drive, Sheets, Calendar, Docs, and Slides. No extras are required for those services.

Enable Google APIs

In Google Cloud Console → Library, enable only the APIs you use:

Product Console / docs
Drive Enable Drive API · Drive docs
Sheets Enable Sheets API · Sheets docs
Calendar Enable Calendar API · Calendar docs
Docs Enable Docs API · Docs docs
Slides Enable Slides API · Slides docs

Broken environments

If client libraries were removed or the environment is incomplete, service calls raise MissingExtraError:

Google Drive support requires Google client libraries.
Install or reinstall with:
    uv add googlekit

Development install

git clone https://github.com/SSujitX/GoogleKit.git
cd GoogleKit
uv sync --group dev

Docs site builds:

uv run mkdocs build --strict

On the Docs GitHub Actions workflow (GOOGLEKIT_SOCIAL_CARDS=true), Material generates social cards (Cairo is available on Ubuntu runners). Local Windows builds skip card images by default.