fw-gdrive

Helper library that provides a set of utilities to integrate Google Drive for common tasks including uploading files, deleting files and modifying Google Documents.

Installation

Add as a poetry dependency to your project:

poetry add fw-gdrive

Usage

Instantiate Google API Client

from fw_gdrive import gapi
# Specify the Drive API scopes
DEFAULT_GOOGLE_API_SCOPE = [
    # Default Drive API scopes
    "https://www.googleapis.com/auth/drive",
    "https://www.googleapis.com/auth/drive.appdata",
    "https://www.googleapis.com/auth/drive.file",
    "https://www.googleapis.com/auth/drive.metadata",
    "https://www.googleapis.com/auth/drive.metadata.readonly",
    "https://www.googleapis.com/auth/drive.photos.readonly",
    "https://www.googleapis.com/auth/drive.readonly",
    "https://www.googleapis.com/auth/drive.scripts",]

# instantiate Google API Client
google_api_client = gapi.GoogleAPIClient(service_cred_path=<path-to-credentials>, scopes=DEFAULT_GOOGLE_API_SCOPE)

# use the API Client to instantiate a Google Drive Folder object
gdrive_folder_obj = gapi.GoogleDriveFolder(folder_id=<folder-id>, api_client=google_api_client)

Upload file to Google Drive Folder

Once you have instantiated a Google Drive Folder object you can use upload_file method to upload file to that folder.

gdrive_folder_obj = gapi.GoogleDriveFolder(folder_id=<folder-id>, api_client=google_api_client)
gdocs_file_obj = gdrive_folder_obj.upload_file(file_name=<name-of-file-you-uploading>, file_path=<path-to-file-you-uploading>)

Modify Google Documents File content

There's a few handy method under fw_gdrive.utils that allow you to build request to modify the Google Documents file. Here is a quick example of how to replace text in the documents using gapi.utils.replace_text

from fw_gdrive import utils
replace_text_request = utils.replace_text(targeted_text="dummy name", 
                        replacement_text="a better name")
update_gear_name_result = google_docs_file_obj.update_document_request(request_call=[replace_text_request])

License

PUBLIC: