Skip to main content

A Python library for working with Google Slides API using Pydantic domain objects

Project description

gslides-api

A Python library for working with Google Slides API using Pydantic domain objects.

Overview

This library provides a Pythonic interface to the Google Slides API with:

  • Pydantic domain objects that match the JSON structure returned by the Google Slides API
  • Type-safe operations with full type hints support
  • Easy-to-use methods for creating, reading, and manipulating Google Slides presentations
  • Comprehensive coverage of Google Slides API features

Installation

pip install gslides-api

Quick Start

Authentication

First, set up your Google API credentials. See CREDENTIALS.md for detailed instructions.

from gslides_api import initialize_credentials

# Initialize with your credentials directory
initialize_credentials("/path/to/your/credentials/")

Basic Usage

from gslides_api import Presentation

# Load an existing presentation
presentation = Presentation.from_id("your-presentation-id")

# Create a new blank presentation
new_presentation = Presentation.create_blank("My New Presentation")

# Access slides
for slide in presentation.slides:
    print(f"Slide ID: {slide.objectId}")
    
# Create a new slide
new_slide = presentation.add_slide()

Features

  • Domain Objects: Complete Pydantic models for all Google Slides API objects
  • Presentations: Create, load, copy, and manipulate presentations
  • Slides: Add, remove, duplicate, and reorder slides
  • Elements: Work with text boxes, shapes, images, and other slide elements
  • Layouts: Access and use slide layouts and masters
  • Requests: Type-safe request builders for batch operations
  • Markdown Support: Convert between Markdown and Google Slides content
  • MCP Server: Expose Google Slides operations as tools for AI assistants

MCP Server

gslides-api includes an MCP (Model Context Protocol) server that exposes Google Slides operations as tools for AI assistants like Claude.

Installation

pip install gslides-api[mcp]

Quick Start

# Set credentials path
export GSLIDES_CREDENTIALS_PATH=/path/to/credentials

# Run the MCP server
python -m gslides_api.mcp.server

Available Tools

Tool Description
get_presentation Get full presentation by URL or ID
get_slide Get slide by name (speaker notes)
get_element Get element by slide and element name
get_slide_thumbnail Get slide thumbnail image
read_element_markdown Read text element as markdown
write_element_markdown Write markdown to text element
replace_element_image Replace image from URL
copy_slide Duplicate a slide
move_slide Reorder slide position
delete_slide Remove a slide

MCP Configuration

Add to your .mcp.json:

{
  "gslides": {
    "type": "stdio",
    "command": "python",
    "args": ["-m", "gslides_api.mcp.server"]
  }
}

The server reads credentials from GSLIDES_CREDENTIALS_PATH environment variable. Use --credential-path to override.

See docs/MCP_SERVER.md for detailed documentation.

API Coverage

The library covers most Google Slides API functionality including:

  • Presentations and slides management
  • Text elements and formatting
  • Shapes and images
  • Tables and charts
  • Page layouts and masters
  • Batch update operations

Requirements

  • Python 3.8+
  • Google API credentials (OAuth2 or Service Account)

Dependencies

  • google-api-python-client - Google API client library
  • google-auth-oauthlib - OAuth2 authentication
  • pydantic - Data validation and serialization
  • marko - Markdown processing
  • protobuf - Protocol buffer support

Development

Running Tests

pip install -e ".[test]"
pytest

Code Formatting

pip install -e ".[dev]"
black gslides_api/
isort gslides_api/

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Related Projects

  • md2googleslides - TypeScript library for creating slides from Markdown
  • gslides - Python library focused on charts and tables
  • gslides-maker - Generate slides from Wikipedia content

Acknowledgments

This library is built on top of the excellent Google API Python client and leverages the power of Pydantic for type-safe data handling.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

gslides_api-0.3.1.tar.gz (90.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

gslides_api-0.3.1-py3-none-any.whl (112.6 kB view details)

Uploaded Python 3

File details

Details for the file gslides_api-0.3.1.tar.gz.

File metadata

  • Download URL: gslides_api-0.3.1.tar.gz
  • Upload date:
  • Size: 90.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.3 CPython/3.11.11 Linux/5.15.0-139-generic

File hashes

Hashes for gslides_api-0.3.1.tar.gz
Algorithm Hash digest
SHA256 068f334bd32f383572a58bb1e2d4a46a08c1c6c31981fce15082b134975b123f
MD5 09b61539545ea176073271096a145672
BLAKE2b-256 991997facfe98cd139d78d3651cbc977eb6113466bd06222a1a6345057c42d16

See more details on using hashes here.

File details

Details for the file gslides_api-0.3.1-py3-none-any.whl.

File metadata

  • Download URL: gslides_api-0.3.1-py3-none-any.whl
  • Upload date:
  • Size: 112.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.3 CPython/3.11.11 Linux/5.15.0-139-generic

File hashes

Hashes for gslides_api-0.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 d783bb3825bc10c16c255387a48680556ca7e88b28a7152ac8f412995e6af4ef
MD5 f69f6f420c1dba43020ddd7a9f326899
BLAKE2b-256 5edafbf5a135e40eae986d499e7c7e2c134063ad91960e9b646420534f7b44e4

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page