Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mingrammer/sheet2db
A tiny python library for syncing data from google spreadsheet to database
https://github.com/mingrammer/sheet2db
spreadsheet sync
Last synced: about 2 months ago
JSON representation
A tiny python library for syncing data from google spreadsheet to database
- Host: GitHub
- URL: https://github.com/mingrammer/sheet2db
- Owner: mingrammer
- License: mit
- Created: 2018-06-07T06:57:27.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2022-12-08T06:37:27.000Z (about 2 years ago)
- Last Synced: 2024-10-14T00:50:53.271Z (3 months ago)
- Topics: spreadsheet, sync
- Language: Python
- Homepage:
- Size: 66.4 KB
- Stars: 19
- Watchers: 2
- Forks: 1
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Sheet2db
Sync the Google spreadsheet to database
Sheet2db is a tiny python library for one-way syncing the Google spreadsheet to database. (Currently, it supports only MySQL)
It is useful for managing some static data on Google spreadsheet, but also want to sync the sheet data to database.
***Sheet2db DOES NOT collect any your secret values!***
# Installation
```
pip install sheet2db
```
# Usage
> You must have API key or OAuth credentials which is accessible to Google Spreadsheet API.
Example sheet format (**items** tab):
````
===========================
| A | B | C | D |
===========================
| id | name | count | ver |
|----|------|-------|-----|
| .. | .... | ..... | ... |
===========================
````
Following example will sync **items** tab of **1U3un2ZJPRhLrWzc2DMXq8VI7Nqf9pYlajfO4mQVCZpE** spreadsheet to database:
> "AIzaSyC6pabjqmaPiguYoHbq4W7a0DV0wQg5JGk" is a fake api key.
```python
from sheet2db import Sheet2db
# Pass API key
syncer = Sheet2db(api_key='AIzaSyC6pabjqmaPiguYoHbq4W7a0DV0wQg5JGk')
# If you need to access to private spreadsheet, you can't use API key. Use oauth credentials instead.
syncer = Sheet2db(
creds_path='credentials.json',
token_path='token.json')
# Fetch data from spreadsheet
syncer.fetch(
sheet='1U3un2ZJPRhLrWzc2DMXq8VI7Nqf9pYlajfO4mQVCZpE',
tab='items',
range='A1:D')
# Sync fetched data to database (mysql)
syncer.sync(
host='192.168.168.10',
port=3306,
user='mingrammer',
password='p@ssw0rd',
db='static',
table='items')
```
You can also sync to remote database via ssh tunneling with **sshtunnel**.
```python
with sshtunnel.SSHTunnelForwarder(
('db.service.io', 22),
ssh_username='ssh_user'
ssh_pkey='~/.ssh/id_rsa'
ssh_private_key_password='ssh_pk_password',
remote_bind_address=('localhost', 3306),
) as tunnel:
syncer.sync(
host = tunnel.local_bind_host,
port = tunnel.local_bind_port,
user = 'mingrammer',
password = 'p@ssw0rd',
db = 'static',
table = 'items')
```
# License
MIT