Skip to main content

python interface of the google apps service

Project description

Build Google Workspace add-ons in Python 🐍 !!!

***

Build Status Deployment Code Quality License Contribution PR


📝 Table of Contents

❗ What is GAPPS?

GAPPS is a library that allows developers to easily and flexibly build add-ons for Google Workspace using Python 🐍. With GAPPS, you can create powerful tools and integrations for Gmail, Google Chat, Calendar, Sheets, Drive, Docs and other Google Workspace apps, that can streamline your workflow and automate common tasks.

⚡ Key Features

  • A simple and easy-to-use API for building Google Workspace add-ons.
  • Flexible interface that can be used for a variety of use cases.
  • Built-in support for Gmail, Google Calendar, Google Drive and other Google Workspace apps.
  • Well-documented, well-maintained codebase and easy to contribute.

🏁 Getting Started

🚜 Installation

This client is hosted at PyPi under the name gapps, to install it, simply run

pip install gapps

or install dev version:

git clone https://github.com/skoudoro/gapps.git
pip install -e .

⚙️ CardService: Choose your coding style!

GAPPS allows you to build extensions by following your favorite coding style

Appscript Style

from gapps import CardService

def create_cat_card(text):
    # Use the "Cat as a service" API to get the cat image. Add a "time" URL
    # parameter to act as a cache buster.
    now = datetime.now()
    caption = text.replace('/', ' ')
    imageUrl = f'https://cataas.com/cat/says/{caption}?time={now.timestamp()}'

    image = CardService.newImage() \
        .setImageUrl(imageUrl)  \
        .setAltText('Meow')

    # Create a button that changes the cat image when pressed.
    # Note: Action parameter keys and values must be strings.
    action = CardService.newAction()  \
        .setFunctionName('on_change_cat') \
        .setParameters({'text': text, 'is_homepage': str(is_homepage)})

    button = CardService.newTextButton()  \
        .setText('Change cat')  \
        .setOnClickAction(action)  \
        .setTextButtonStyle(CardService.TextButtonStyle.FILLED)

    buttonSet = CardService.newButtonSet()  \
        .addButton(button)

    # Assemble the widgets and return the card.
    section = CardService.newCardSection()  \
        .addWidget(image)  \
        .addWidget(buttonSet)

    card = CardService.newCardBuilder()  \
        .addSection(section)

    return card.build()

Pythonic Style

from gapps import CardService

def create_cat_card(text):
    # Use the "Cat as a service" API to get the cat image. Add a "time" URL
    # parameter to act as a cache buster.
    now = datetime.now()
    caption = text.replace('/', ' ')
    imageUrl = f'https://cataas.com/cat/says/{caption}?time={now.timestamp()}'

    image = CardService.Image(image_url=imageUrl, alt_text='Meow')
    action = CardService.Action(
        function_name='on_change_cat',
        parameters={'text': text, 'is_homepage': str(is_homepage)})
    button = CardService.TextButton(
        text='Change cat', action=action,
        text_button_style=CardService.TextButtonStyle.FILLED)
    button_set = CardService.ButtonSet(button=button)
    section = CardService.CardSection(widget=[image, button_set])

    card = CardService.CardBuilder(section=section)

    return card.build()

⛏️ Card Builder

The online Card builder can help you prototype your app's interface.

🚀 Demos

Check out the examples folder for sample codes. It contains the following examples:

  • cats.py: Mirror of google Cats example. Compatible with Gmail, Google Calendar, Google Drive, Google Docs and Google sheets
  • simple_demo.py: minimalistic example to show how to build a basic card.
  • card_builder.py: This example show how to reproduce all the templates from the online Card builder. It can help you prototype your app's interface.

💬 Tutorials

Coming soon...

📄 Methods reference

CardService: For the complete reference, visit the official Google Workspace Add Ons API reference.

⚠️ Notes

We still need to handle some widgets/builders but 90% of them are working correctly

✅ Tests

  • Step 1: Install pytest
  pip install pytest
  • Step 2: Run the tests
  pytest -svv gapps

✨ Contribute

We love contributions!

You've discovered a bug or something else you want to change - excellent! Create an issue!

You've worked out a way to fix it – even better! Submit a Pull Request!

Start with the contributing guide!

Do you like GAPPS?

Show us with a star on github...

Star GAPPS

🎓 License

Project under MIT license, more information here

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

gapps-0.1.1.tar.gz (274.4 kB view details)

Uploaded Source

Built Distribution

gapps-0.1.1-py3-none-any.whl (19.9 kB view details)

Uploaded Python 3

File details

Details for the file gapps-0.1.1.tar.gz.

File metadata

  • Download URL: gapps-0.1.1.tar.gz
  • Upload date:
  • Size: 274.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.18

File hashes

Hashes for gapps-0.1.1.tar.gz
Algorithm Hash digest
SHA256 2565a120898f539d5ffe72e481d4736141c77397af02d9221532b439602289cb
MD5 dcacc0a192bb998aec1c3a23a4f94784
BLAKE2b-256 e8513ef97fc5d77709eff75fe44535211bdc4005a694fba07705495c38f111af

See more details on using hashes here.

Provenance

File details

Details for the file gapps-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: gapps-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 19.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.18

File hashes

Hashes for gapps-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 8bdb672c85a2f1532fd4dfeedd7f825db15cf7a19c2361f417003463a840e1fc
MD5 3ff91652e98502bd46f94cb8869f8a32
BLAKE2b-256 6ffe82d6d66bbb03a274f8a3fc7499438e6ae33986c74b9d4f8c0975cfa69315

See more details on using hashes here.

Provenance

Supported by

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