Skip to main content

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: MIT

Metadata

Release files for fw-gdrive 0.3.3

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Built distribution (wheel)

Table of built distributions (wheels) for fw-gdrive 0.3.3
File Interpreter ABI Platform Actions
fw_gdrive-0.3.3-py3-none-any.whl Python 3 none any Details for fw_gdrive-0.3.3-py3-none-any.whl

Release files / fw_gdrive-0.3.3-py3-none-any.whl

Download URL fw_gdrive-0.3.3-py3-none-any.whl
Size 9.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
242cca9d191856380911a642b1d5628f480ba22450e69570596d975191c89c4e
BLAKE2b-256 checksum
How to use checksums
3140e3f75fdab761870a3e1e6d28429bc65e6e4e57698cb8b35ccdc0f61574c9
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.4.1 CPython/3.11.2 Linux/5.10.162+

Security for fw-gdrive 0.3.3

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page