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

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.1.30.tar.gz (60.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.1.30-py3-none-any.whl (77.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: gslides_api-0.1.30.tar.gz
  • Upload date:
  • Size: 60.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.1.30.tar.gz
Algorithm Hash digest
SHA256 f76a67d9e0bbbc18c99dd19ef1c25de838a771171e66a0a1aad3c7f4b0a7cbf9
MD5 c9f9fc50c9d5dc26dcee09cc4bb3490b
BLAKE2b-256 165b94c9caee5ea720e706bf99fe729a449a6e969236556702ee662bb7804eaa

See more details on using hashes here.

File details

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

File metadata

  • Download URL: gslides_api-0.1.30-py3-none-any.whl
  • Upload date:
  • Size: 77.0 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.1.30-py3-none-any.whl
Algorithm Hash digest
SHA256 938c92a6994b8bfaa6d5fa87d5c290a36cbc2e61b5a98621eb53b0875e086310
MD5 95da54dd066219fd5ea7017fac6e1d74
BLAKE2b-256 1226bc4ffd5b8dab676b5f6f00ddee20e3f64e649bf330a9a8f76b9b12964c3a

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