https://github.com/condad/google-objects-python
Wraps google-api-python-client for pythonic Google API interaction.
https://github.com/condad/google-objects-python
google-drive google-sheets-api google-slides-api python python-3 sheet
Last synced: 9 months ago
JSON representation
Wraps google-api-python-client for pythonic Google API interaction.
- Host: GitHub
- URL: https://github.com/condad/google-objects-python
- Owner: condad
- License: apache-2.0
- Created: 2016-10-03T22:40:25.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2022-12-08T12:50:50.000Z (about 3 years ago)
- Last Synced: 2025-04-12T20:13:23.511Z (9 months ago)
- Topics: google-drive, google-sheets-api, google-slides-api, python, python-3, sheet
- Language: Python
- Homepage:
- Size: 170 KB
- Stars: 10
- Watchers: 1
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Google Objects
Thin, pythonic OO wrapper around Google's "google-api-python-client" library.
Currently supports Python 3+
## Installation
```bash
$ pip install google-objects
```
## Usage
Requires a valid Google API Credentials object from Google's excellent oauth2lib library. For more information, visit [here](https://developers.google.com/identity/protocols/OAuth2).
### Google Drive v3
- Retrieve drive 'About' information:
```python
from google_objects import DriveClient
gdrive = DriveClient(OAUTH2LIB_CREDS)
about = gdrive.get_about()
print(about.email)
print(about.name)
# prints link to profile photo
print(about.photo)
# ...
```
- List files in drive by type:
```python
files_by_type = {
'slides': gdrive.list_files('presentation'),
'folders': gdrive.list_files('folder'),
'spreadsheets': gdrive.list_files('spreadsheets'),
}
for file in files_by_type['folders']:
print(file.id)
print(file.name)
for file in files_by_type['spreadsheets']:
# prints list of parent folder IDs
print(file.parents)
# ...
```
- Copy and share file:
```python
file = gdrive.get_file('FILE_ID')
new_file = file.copy('NEW_FILE_NAME', ['PARENT_FOLDER_1', 'PARENT_FOLDER_2'])
# allow myfriend@hotmail.com to view
permission = new_file.add_permission('myfriend@hotmail.com')
# print newly created permission information
print(permission.role, permission.type, permission.email)
```
### Google Slides v1
- Retrieve presentation and loop through elements:
```python
from google_objects import SlidesClient
gslides = SlidesClient(OAUTHLIB_CREDS)
presentation = gslides.get_presentation('PRESENTATION_ID')
# print slides attributes
for slide in presentation:
print(slide.id)
for element in slide: # equivalent to 'for element in presentation.elements()'
print(element.type)
# Shape, Table, etc
```
- Check text in shape:
```python
shape = presentation.get_element_by_id('SHAPE_ID')
for segment in shape.text:
print(segment.text)
```
- Batch update every cell in table:
```python
# use with to perform batch updates in block
with presentation as pres:
table = pres.get_element_by_id('TABLE_ID')
for cell in table:
print(cell.location) # tuple containing cell location
for segment in cell.text:
# update cell
segment.text = 'UPDATED_VALUE'
```
### Google Sheets v4
- Retrieve spreadsheet and loop through sheets:
```python
from google_objects import SheetsClient
gsheets = SheetsClient(OAUTHLIB_CREDS)
spreadsheet = gsheets.get_spreadsheet('SPREADSHEET_ID')
for sheet in spreadsheet:
print(sheet.id, sheet.title)
```
- Get sheet by name and return its full block of values:
```python
sheet = spreadsheet['Sheet 1']
values = sheet.values()
```
- Get named range value block:
```python
named_ranges = spreadsheet.named_ranges('SHEET_NAME!A:C')
for rng in named_range:
values = named_range.get_block()
```
- Update values block:
```python
values = spreadsheet.get_range('SHEET_NAME!A:C')
# loop through rows
for i, row in enumerate(values):
values[i] = [1, 2, 3]
print(row)
values.update()
# you can also use the slice syntax for updating..
values[2:5] = [[1,2,4], [4, 5, 6], [6, 7, 8]]
values.update()
```
- Append to values block:
```python
to_append = [[1, 2, 3], [4, 5, 6]]
values.append(to_append)
```