google-drive-export 0.1.0__tar.gz

google_drive_export-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Corey Goldberg
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

google_drive_export-0.1.0/PKG-INFO

@@ -0,0 +1,156 @@
+Metadata-Version: 2.4
+Name: google-drive-export
+Version: 0.1.0
+Summary: Export your Google Drive data
+Author: Corey Goldberg
+Maintainer: Corey Goldberg
+License-Expression: MIT
+Project-URL: homepage, https://github.com/cgoldberg/google-drive-export
+Project-URL: source, https://github.com/cgoldberg/google-drive-export
+Project-URL: download, https://pypi.org/project/google-drive-export
+Keywords: google,drive,google-drive,backup,export,takeout
+Classifier: Environment :: Console
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: google-api-python-client==2.168.0
+Requires-Dist: google-auth-httplib2==0.2.0
+Requires-Dist: google-auth-oauthlib==1.2.2
+Dynamic: license-file
+
+# google-drive-export
+
+### Export your Google Drive data
+
+- Copyright (c) 2025 [Corey Goldberg][github-home]
+- License: [MIT][mit-license]
+- Development: [GitHub][github-repo]
+- Download/Install: [PyPI][pypi]
+
+[github-home]: https://github.com/cgoldberg
+[mit-license]: https://raw.githubusercontent.com/cgoldberg/google-drive-export/refs/heads/master/LICENSE
+[github-repo]: https://github.com/cgoldberg/google-drive-export
+[pypi]: https://pypi.org/project/google-drive-export
+
+----
+
+## About:
+
+This is a command line tool for exporting your personal Google Drive files using the Google Drive API v3.
+
+It will export all files that are owned by your account (not shared with you from other users), and
+will not save native Google App files (Docs/Sheets/Slides/Forms/etc). Files are saved in their appropriate
+directory structure inside a directory named `exported_files`.
+
+For more information:
+- [API Overview][api-overview]
+- [REST API Reference][api-reference]
+- [API Guides][api-guides]
+
+[api-overview]: https://developers.google.com/workspace/drive/api
+[api-reference]: https://developers.google.com/workspace/drive/api/reference/rest/v3
+[api-guides]: https://developers.google.com/workspace/drive/api/guides/about-files
+
+----
+
+## Requirements:
+
+- Python 3.9+
+- Packages:
+  - google-api-python-client
+  - google-auth-httplib2
+  - google-auth-oauthlib
+
+----
+
+## Usage:
+
+```
+usage: google_drive_export [-h] [--dir DIR]
+
+options:
+  -h, --help  show this help message and exit
+  --dir DIR   output directory
+```
+
+----
+
+## Installation:
+
+### Create a virtual environment and install with pip
+
+- On Linux/Mac:
+
+```
+python3 -m venv venv
+source venv/bin/activate
+pip install google-drive-export
+```
+
+- On Windows:
+
+```
+py -m venv venv
+venv\Scripts\activate
+pip install google-drive-export
+```
+
+For more information on virtual env and pip, see:
+- https://packaging.python.org/en/latest/tutorials/installing-packages
+
+### Install globally with pipx
+
+```
+pipx install google-drive-export
+```
+
+For more information on pipx, see:
+- https://github.com/pypa/pipx
+
+----
+
+## Authorization for use with Google Drive:
+
+After installing, you must follow these steps:
+
+### 1. Enable the Google Drive API
+
+- Go to the Google Cloud console (Enable access to API)
+  - https://console.cloud.google.com/flows/enableapi?apiid=drive.googleapis.com
+- Create a Project
+- Enable the API
+
+### 2. Configure the OAuth Consent screen
+
+- Go to the Google Cloud console (Branding)
+  - https://console.cloud.google.com/auth/branding
+- Configure your Project
+- Go to the Google Cloud console (Audience)
+  - https://console.cloud.google.com/auth/audience
+- Add yourself as a Test user
+
+### 3. Authorize credentials for a desktop application
+
+- Go to the Google Cloud console (Clients)
+  - https://console.cloud.google.com/auth/clients
+  - Create a Client (Application type > Desktop app)
+  - Downloaded JSON file, rename it to credentials.json, and move it to your working directory
+
+### 4. Run the program
+
+```
+google_drive_export
+```
+
+- The first time you run it, a browser window will open and you will be prompted to authorize access to your Google account:
+  - If you are not already signed in to your Google Account, sign in when prompted
+  - If you are signed in to multiple accounts, select the account to use for authorization
+  - Click Accept
+- Authorization information is stored in the file system (`token.json`), so the next time you run it, you aren't prompted for authorization

google_drive_export-0.1.0/README.md

@@ -0,0 +1,129 @@
+# google-drive-export
+
+### Export your Google Drive data
+
+- Copyright (c) 2025 [Corey Goldberg][github-home]
+- License: [MIT][mit-license]
+- Development: [GitHub][github-repo]
+- Download/Install: [PyPI][pypi]
+
+[github-home]: https://github.com/cgoldberg
+[mit-license]: https://raw.githubusercontent.com/cgoldberg/google-drive-export/refs/heads/master/LICENSE
+[github-repo]: https://github.com/cgoldberg/google-drive-export
+[pypi]: https://pypi.org/project/google-drive-export
+
+----
+
+## About:
+
+This is a command line tool for exporting your personal Google Drive files using the Google Drive API v3.
+
+It will export all files that are owned by your account (not shared with you from other users), and
+will not save native Google App files (Docs/Sheets/Slides/Forms/etc). Files are saved in their appropriate
+directory structure inside a directory named `exported_files`.
+
+For more information:
+- [API Overview][api-overview]
+- [REST API Reference][api-reference]
+- [API Guides][api-guides]
+
+[api-overview]: https://developers.google.com/workspace/drive/api
+[api-reference]: https://developers.google.com/workspace/drive/api/reference/rest/v3
+[api-guides]: https://developers.google.com/workspace/drive/api/guides/about-files
+
+----
+
+## Requirements:
+
+- Python 3.9+
+- Packages:
+  - google-api-python-client
+  - google-auth-httplib2
+  - google-auth-oauthlib
+
+----
+
+## Usage:
+
+```
+usage: google_drive_export [-h] [--dir DIR]
+
+options:
+  -h, --help  show this help message and exit
+  --dir DIR   output directory
+```
+
+----
+
+## Installation:
+
+### Create a virtual environment and install with pip
+
+- On Linux/Mac:
+
+```
+python3 -m venv venv
+source venv/bin/activate
+pip install google-drive-export
+```
+
+- On Windows:
+
+```
+py -m venv venv
+venv\Scripts\activate
+pip install google-drive-export
+```
+
+For more information on virtual env and pip, see:
+- https://packaging.python.org/en/latest/tutorials/installing-packages
+
+### Install globally with pipx
+
+```
+pipx install google-drive-export
+```
+
+For more information on pipx, see:
+- https://github.com/pypa/pipx
+
+----
+
+## Authorization for use with Google Drive:
+
+After installing, you must follow these steps:
+
+### 1. Enable the Google Drive API
+
+- Go to the Google Cloud console (Enable access to API)
+  - https://console.cloud.google.com/flows/enableapi?apiid=drive.googleapis.com
+- Create a Project
+- Enable the API
+
+### 2. Configure the OAuth Consent screen
+
+- Go to the Google Cloud console (Branding)
+  - https://console.cloud.google.com/auth/branding
+- Configure your Project
+- Go to the Google Cloud console (Audience)
+  - https://console.cloud.google.com/auth/audience
+- Add yourself as a Test user
+
+### 3. Authorize credentials for a desktop application
+
+- Go to the Google Cloud console (Clients)
+  - https://console.cloud.google.com/auth/clients
+  - Create a Client (Application type > Desktop app)
+  - Downloaded JSON file, rename it to credentials.json, and move it to your working directory
+
+### 4. Run the program
+
+```
+google_drive_export
+```
+
+- The first time you run it, a browser window will open and you will be prompted to authorize access to your Google account:
+  - If you are not already signed in to your Google Account, sign in when prompted
+  - If you are signed in to multiple accounts, select the account to use for authorization
+  - Click Accept
+- Authorization information is stored in the file system (`token.json`), so the next time you run it, you aren't prompted for authorization

google_drive_export-0.1.0/google_drive_export.egg-info/PKG-INFO

@@ -0,0 +1,156 @@
+Metadata-Version: 2.4
+Name: google-drive-export
+Version: 0.1.0
+Summary: Export your Google Drive data
+Author: Corey Goldberg
+Maintainer: Corey Goldberg
+License-Expression: MIT
+Project-URL: homepage, https://github.com/cgoldberg/google-drive-export
+Project-URL: source, https://github.com/cgoldberg/google-drive-export
+Project-URL: download, https://pypi.org/project/google-drive-export
+Keywords: google,drive,google-drive,backup,export,takeout
+Classifier: Environment :: Console
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: google-api-python-client==2.168.0
+Requires-Dist: google-auth-httplib2==0.2.0
+Requires-Dist: google-auth-oauthlib==1.2.2
+Dynamic: license-file
+
+# google-drive-export
+
+### Export your Google Drive data
+
+- Copyright (c) 2025 [Corey Goldberg][github-home]
+- License: [MIT][mit-license]
+- Development: [GitHub][github-repo]
+- Download/Install: [PyPI][pypi]
+
+[github-home]: https://github.com/cgoldberg
+[mit-license]: https://raw.githubusercontent.com/cgoldberg/google-drive-export/refs/heads/master/LICENSE
+[github-repo]: https://github.com/cgoldberg/google-drive-export
+[pypi]: https://pypi.org/project/google-drive-export
+
+----
+
+## About:
+
+This is a command line tool for exporting your personal Google Drive files using the Google Drive API v3.
+
+It will export all files that are owned by your account (not shared with you from other users), and
+will not save native Google App files (Docs/Sheets/Slides/Forms/etc). Files are saved in their appropriate
+directory structure inside a directory named `exported_files`.
+
+For more information:
+- [API Overview][api-overview]
+- [REST API Reference][api-reference]
+- [API Guides][api-guides]
+
+[api-overview]: https://developers.google.com/workspace/drive/api
+[api-reference]: https://developers.google.com/workspace/drive/api/reference/rest/v3
+[api-guides]: https://developers.google.com/workspace/drive/api/guides/about-files
+
+----
+
+## Requirements:
+
+- Python 3.9+
+- Packages:
+  - google-api-python-client
+  - google-auth-httplib2
+  - google-auth-oauthlib
+
+----
+
+## Usage:
+
+```
+usage: google_drive_export [-h] [--dir DIR]
+
+options:
+  -h, --help  show this help message and exit
+  --dir DIR   output directory
+```
+
+----
+
+## Installation:
+
+### Create a virtual environment and install with pip
+
+- On Linux/Mac:
+
+```
+python3 -m venv venv
+source venv/bin/activate
+pip install google-drive-export
+```
+
+- On Windows:
+
+```
+py -m venv venv
+venv\Scripts\activate
+pip install google-drive-export
+```
+
+For more information on virtual env and pip, see:
+- https://packaging.python.org/en/latest/tutorials/installing-packages
+
+### Install globally with pipx
+
+```
+pipx install google-drive-export
+```
+
+For more information on pipx, see:
+- https://github.com/pypa/pipx
+
+----
+
+## Authorization for use with Google Drive:
+
+After installing, you must follow these steps:
+
+### 1. Enable the Google Drive API
+
+- Go to the Google Cloud console (Enable access to API)
+  - https://console.cloud.google.com/flows/enableapi?apiid=drive.googleapis.com
+- Create a Project
+- Enable the API
+
+### 2. Configure the OAuth Consent screen
+
+- Go to the Google Cloud console (Branding)
+  - https://console.cloud.google.com/auth/branding
+- Configure your Project
+- Go to the Google Cloud console (Audience)
+  - https://console.cloud.google.com/auth/audience
+- Add yourself as a Test user
+
+### 3. Authorize credentials for a desktop application
+
+- Go to the Google Cloud console (Clients)
+  - https://console.cloud.google.com/auth/clients
+  - Create a Client (Application type > Desktop app)
+  - Downloaded JSON file, rename it to credentials.json, and move it to your working directory
+
+### 4. Run the program
+
+```
+google_drive_export
+```
+
+- The first time you run it, a browser window will open and you will be prompted to authorize access to your Google account:
+  - If you are not already signed in to your Google Account, sign in when prompted
+  - If you are signed in to multiple accounts, select the account to use for authorization
+  - Click Accept
+- Authorization information is stored in the file system (`token.json`), so the next time you run it, you aren't prompted for authorization

google_drive_export-0.1.0/google_drive_export.egg-info/SOURCES.txt

@@ -0,0 +1,10 @@
+LICENSE
+README.md
+google_drive_export.py
+pyproject.toml
+google_drive_export.egg-info/PKG-INFO
+google_drive_export.egg-info/SOURCES.txt
+google_drive_export.egg-info/dependency_links.txt
+google_drive_export.egg-info/entry_points.txt
+google_drive_export.egg-info/requires.txt
+google_drive_export.egg-info/top_level.txt

google_drive_export-0.1.0/google_drive_export.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

google_drive_export-0.1.0/google_drive_export.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+google_drive_export = google_drive_export:main

google_drive_export-0.1.0/google_drive_export.egg-info/requires.txt

@@ -0,0 +1,3 @@
+google-api-python-client==2.168.0
+google-auth-httplib2==0.2.0
+google-auth-oauthlib==1.2.2

google_drive_export-0.1.0/google_drive_export.egg-info/top_level.txt

@@ -0,0 +1 @@
+google_drive_export

google_drive_export-0.1.0/google_drive_export.py

@@ -0,0 +1,205 @@
+#!/usr/bin/env python3
+# Corey Goldberg, 2025
+# License: MIT
+
+"""Export your Google Drive data"""
+
+
+import argparse
+import io
+import math
+import os
+import shutil
+import sys
+
+from google.auth.transport.requests import Request
+from google.oauth2.credentials import Credentials
+from google_auth_oauthlib.flow import InstalledAppFlow
+from googleapiclient.discovery import build
+from googleapiclient.errors import HttpError
+from googleapiclient.http import MediaIoBaseDownload
+
+
+class GDriveExport:
+
+    def __init__(self, working_dir, token_file, creds_file):
+        self.working_dir = working_dir
+        self.token_file = token_file
+        self.creds_file = creds_file
+
+        self.folder_cache = {}
+
+        self.creds = self._authenticate()
+        self.service = build("drive", "v3", credentials=self.creds)
+        self.files = self._get_files()
+        self.files_map = self._map_files()
+
+        for file_path, file_id in self.files_map.items():
+            self._download_file(file_id, file_path)
+
+    def _authenticate(self):
+        # If modifying these scopes, delete the `token.json` file
+        scopes = [
+            "https://www.googleapis.com/auth/drive.metadata.readonly",
+            "https://www.googleapis.com/auth/drive.readonly",
+        ]
+        # The file token.json stores the user's access and refresh tokens,
+        # and is created automatically when the authorization flow completes
+        # for the first time
+        if os.path.exists(self.token_file):
+            creds = Credentials.from_authorized_user_file(self.token_file, scopes)
+        else:
+            creds = None
+        # If there are no (valid) credentials available, let the user log in
+        if not creds or not creds.valid:
+            if creds and creds.expired and creds.refresh_token:
+                creds.refresh(Request())
+            else:
+                flow = InstalledAppFlow.from_client_secrets_file(
+                    self.creds_file, scopes
+                )
+                creds = flow.run_local_server(port=0)
+            # Save the credentials for the next run
+            with open(self.token_file, "w") as token:
+                token.write(creds.to_json())
+        return creds
+
+    def _download_file(self, file_id, file_path):
+        request = self.service.files().get_media(fileId=file_id)
+        bytes = io.BytesIO()
+        try:
+            downloader = MediaIoBaseDownload(bytes, request)
+            while True:
+                _, done = downloader.next_chunk()
+                if done:
+                    break
+        except HttpError as e:
+            # Only files with binary content can be downloaded, not native
+            # Google App files (Docs/Sheets/Slides/Forms/etc)
+            if (
+                e.status_code == 403
+                and e.error_details[0]["reason"] == "fileNotDownloadable"
+                and "only files with binary content can be downloaded"
+                in e.reason.lower()
+            ):
+                return None
+            else:
+                raise
+        dir_name = os.path.dirname(file_path)
+        if not os.path.exists(dir_name):
+            os.makedirs(dir_name)
+        with open(file_path, "wb") as f:
+            f.write(bytes.getvalue())
+        print(f"Downloaded: {file_path}")
+        return file_path
+
+    def _get_files(self):
+        about = self.service.about().get(fields="user").execute()
+        email = about["user"]["emailAddress"]
+        files = []
+        page_token = None
+        while True:
+            results = (
+                self.service.files()
+                .list(
+                    q=f"'{email}' in owners and mimeType!='application/vnd.google-apps.folder'",
+                    spaces="drive",
+                    fields="nextPageToken, files(id, name, parents)",
+                    pageToken=page_token,
+                )
+                .execute()
+            )
+            files.extend(results.get("files", []))
+            if not files:
+                raise RuntimeError("No files found in Google Drive")
+            page_token = results.get("nextPageToken", None)
+            if page_token is None:
+                break
+        return files
+
+    def _get_folder_path(self, folder_id):
+        path_parts = []
+        current_id = folder_id
+        while current_id:
+            if current_id in self.folder_cache:
+                folder_name, parent_id = self.folder_cache[current_id]
+            else:
+                folder = (
+                    self.service.files()
+                    .get(fileId=current_id, fields="name, parents")
+                    .execute()
+                )
+                folder_name = folder.get("name")
+                parent_id = folder.get("parents", [None])[0]
+                self.folder_cache[current_id] = (folder_name, parent_id)
+            path_parts.insert(0, folder_name)  # Add to the front
+            current_id = parent_id
+        return os.path.sep.join(path_parts[1:])
+
+    def _map_files(self):
+        files_map = {}
+        for f in self.files:
+            folder_path = self._get_folder_path(f["parents"][0])
+            file_path = os.path.join(self.working_dir, folder_path, f["name"])
+            files_map[file_path] = f["id"]
+        sorted_files_map = {key: files_map[key] for key in sorted(files_map)}
+        return sorted_files_map
+
+
+def dir_size(working_dir):
+    """Size of a directory in bytes, including all subdirectories and files."""
+    size_bytes = 0
+    for entry in os.scandir(working_dir):
+        if entry.is_file():
+            size_bytes += entry.stat().st_size
+        elif entry.is_dir():
+            size_bytes += dir_size(entry.path)
+    return size_bytes
+
+
+def convert_size(size_bytes):
+    if size_bytes == 0:
+        return "0 B"
+    sizes = ("B", "KB", "MB", "GB", "TB", "PB", "EB", "ZB", "YB")
+    i = int(math.floor(math.log(size_bytes, 1024)))
+    p = math.pow(1024, i)
+    s = round(size_bytes / p, 2)
+    return f"{s} {sizes[i]}"
+
+
+def run(working_dir):
+    cur_dir = os.getcwd()
+    token_file = os.path.join(".", "token.json")
+    creds_file = os.path.join(".", "credentials.json")
+    if not os.path.exists(creds_file):
+        sys.exit(f"Can't find required file: {creds_file}")
+    if os.path.exists(working_dir):
+        overwrite = input(
+            f"The '{os.path.basename(working_dir)}' directory already exists. Overwrite? [y/N] "
+        ).lower()
+        if overwrite in ("y", "yes"):
+            shutil.rmtree(working_dir)
+        else:
+            sys.exit("Exiting so files are not overwritten")
+    print(f"\nExporting files to: {working_dir}\n")
+    try:
+        GDriveExport(working_dir, token_file, creds_file)
+    except (HttpError, RuntimeError) as e:
+        sys.exit(f"Error: {e}")
+    size = convert_size(dir_size(working_dir))
+    print(f"\nTotal size: {size}")
+
+
+def main():
+    parser = argparse.ArgumentParser()
+    parser.add_argument("--dir", default=".", help="output directory")
+    args = parser.parse_args()
+    try:
+        working_dir = os.path.join(args.dir, "exported_files")
+        run(working_dir)
+    except KeyboardInterrupt:
+        sys.exit(1)
+
+
+if __name__ == "__main__":
+    main()

google_drive_export-0.1.0/pyproject.toml

@@ -0,0 +1,38 @@
+[build-system]
+requires = ["setuptools"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "google-drive-export"
+version = "0.1.0"
+description = "Export your Google Drive data"
+license = "MIT"
+license-files = ["LICENSE"]
+authors = [{name = "Corey Goldberg"}]
+maintainers = [{name = "Corey Goldberg"}]
+readme = "README.md"
+requires-python = ">= 3.9"
+keywords = ["google", "drive", "google-drive", "backup", "export", "takeout"]
+classifiers = [
+    "Environment :: Console",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+]
+dependencies = [
+    "google-api-python-client==2.168.0",
+    "google-auth-httplib2==0.2.0",
+    "google-auth-oauthlib==1.2.2",
+]
+
+[project.scripts]
+google_drive_export = "google_drive_export:main"
+
+[project.urls]
+homepage = "https://github.com/cgoldberg/google-drive-export"
+source = "https://github.com/cgoldberg/google-drive-export"
+download = "https://pypi.org/project/google-drive-export"

google_drive_export-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+