Drive
Google Drive client.
Install
python -m pip install drive
With Poetry:
poetry add drive
You also need to have libmagic installed to get automatic detection of uploaded files’ MIME types. If you don’t have
it, you must provide the original_mime_type keyword argument when you upload a file.
On Linux, if you do have libmagic but Python can’t see it, see this StackOverflow question.
Requirement: Python 3.9 or higher.
Usage
The API exposes a client as drive.client.Client that manipulates instances of
drive.files.File. A File represent a Google Drive file. Note that both
regular files and directories are represented as Files, and a file can have
multiple parent directories. You can check if a File is a directory using the
is_directory attribute.
Note: "Folder" is just a synonym for "Directory".
Authentication
By default, the client reads your service account key JSON file at the location
given by the environment variable GOOGLE_APPLICATION_CREDENTIALS. You can
override this behavior by passing it directly:
client = Client("/path/to/your/service-account-key.json")
See Google’s documentation on how to create a service account key.
Client
High-level Client methods:
get_file(file_id)(File)get_file_by_name(name)(File)files_shared_with_me()(Filelist)get_shared_directory(name)(File)root()(File)upload_file(parent, path[, name]): Upload a fileupload_excel_workbook(parent, name, workbook): Upload anopenpyxlworkbook in a Google spreadsheet underparentwith the namename.
The client also exposes low-level methods that work on file ids.
File
id(str, attribute)name(str, attribute)is_directory(bool, attribute)human_type(str, attribute): Human-readable file typeexists()(bool)unlink()(bool): Remove the file. If it's a directory, all its children are removed as wellrename(new_name): Rename the filemove_in(new_parent[, new_name]): Move a file under another directory. It can also rename the file at the same time.list(): List a directory’s contentcreate_folder(name): Create a folder under the current oneget_or_create_folder(name): Retrieve a child folder or create it if it doesn’t existget_child(name): Return a file under the current directory.parents(): Return a file's parentsparent(): Return the first parent of a filedownload_file(path[, mime_type]): Download the file at a given locationdownload_workbook(): Download the file as anopenpyxlworkbookjson(): Parse the file as JSONjsons(): Parse the file as JSONS (one JSON per line) and returns a generator
Methods that operate on directories (e.g. list()) generally have no effect if
the File instance is a regular file.
Examples
from drive.client import Client
# Uses credentials from the path in the environment variable
# GOOGLE_APPLICATION_CREDENTIALS.
cl = Client()
# Get the root directory
d = cl.root()
print(d.is_directory) # True
print(d.name) # e.g. "My Drive"
# Get a directory's content
for f in d.list():
print(f.name)
# Get a shared directory
d = cl.get_shared_directory("My Shared Dir")
Spreadsheets
from drive.client import Client
from openpyxl import Workbook
cl = Client()
# Download
f = cl.get_file_by_name("my_sheet")
workbook = f.download_workbook() # openpyxl workbook
# save your download:
workbook.save("myfile.xlsx")
# Upload
workbook = Workbook()
d = cl.get_shared_directory("My Shared Directory")
cl.upload_excel_workbook(d, "my_other_sheet", workbook)
Drawings
from drive.client import Client
cl = Client()
# download a Drawing in a png image
cl.download_file("11AASomeFileId", "localfile.png", "image/png")
License
Copyright © 2016-2025 Baptiste Fontaine
Distributed under the MIT License.
Metadata
Release files for drive 0.4.5
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| drive-0.4.5.tar.gz | 14.0 kB | Without provenance | Details for drive-0.4.5.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| drive-0.4.5-py3-none-any.whl | Python 3 | none | any | Details for drive-0.4.5-py3-none-any.whl |
Total release size: 29.5 kB
Release files / drive-0.4.5.tar.gz
| Download URL | drive-0.4.5.tar.gz |
|---|---|
| Size | 14.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
fe7e0543e5395f7a474b749e0e6e884f1a8dcfc5a282dcff237317cf7522228d
|
|
BLAKE2b-256 checksum How to use checksums |
5e447c8bed9b28b38f5ba565f935fd77516095b81dab03ec131992276c8464b6
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/2.1.1 CPython/3.9.18 Linux/6.8.0-1021-azure
|
Release files / drive-0.4.5-py3-none-any.whl
| Download URL | drive-0.4.5-py3-none-any.whl |
|---|---|
| Size | 15.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
7163dc2c3ea206f9a2e378619be2876527fb144d63c6416fd11fc6362e975694
|
|
BLAKE2b-256 checksum How to use checksums |
17dea98f58ccba93852300e39678aa6fb877379755ffe12d20de6b5a4449f1d2
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/2.1.1 CPython/3.9.18 Linux/6.8.0-1021-azure
|
Security for drive 0.4.5
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.