dlgsheet 0.0.1

Script to Google Sheets to JSON files

Python script for downloading sheets from Google Sheets as JSON files

Requirements

NOTE This information is taken from the google-api documentation for Python from: https://github.com/googleapis/google-api-python-client/blob/master/docs/oauth-server.md

Create a service account

Service accounts allow you to perform server to server, app-level authentication using a robot account. You will create a service account, download a keyfile, and use that to authenticate to Google APIs. To create a service account:

• Go to the Create Service Account Key page
• Click the button Create new service account
• Enter the service account name and the corresponding id.
• Add the additional information regarding users and project permissions (optional)
• Create the service account.

Once it is created you should create a keyfile, then follow the next steps:

• Enter to the newly created service account
• Go to the Keys tab
• Click the button Add key and select JSON.

Save the service account credential file somewhere safe, and do not check this file into source control!

Add permissions to the document

If you want to perform operations in a private file, you should add the service mail (e.g. [e-mail]) to the list of shared users in your document.

You can read this reference which explains this specific requirement: https://github.com/juampynr/google-spreadsheet-reader

Installation

To install this package you must build and install following the procedure suggested for setuptools https://setuptools.readthedocs.io/en/latest/userguide/quickstart.html.

pip install --upgrade setuptools
python -m build .
python install .

You can also use the scrip from the current source by:

pip install -r requirements.txt

How to use

The script could be used installed in your local environment, or directly from the location of the package source.

If you have installed it, the command name is dlgsheet and admits the next options:

dlgsheet [options]

Options:

• -h, --help

  Show this help message and exit

• -l LOGLEVEL, --log-level=LOGLEVEL

  Set log level. Available options: critical, error, warning, info, debug

• -c FILE, --credentials-file=FILE

  Set credentials file name

• -o FILE, --output-file=FILE

  Save to output file

• -d FOLDEr, --output-folder=FOLDER

  Save to output folder

• -s SPREADSHEETID, --spreadsheet-id=SPREADSHEETID

  Set google spreadsheet id to write on

• -t SHEETNAME, --sheetname=SHEETNAME

  Set google sheetname to write on

From these options, providing the --spreadsheet-id is mandatory either via the command line or via an environmental variable GOOGLE_SPREADSHEET_ID.

Then, it is required also that you provide the key file downloaded from the Google service account, explained above. It should be defined via the option --credentials-file, otherwise it will use the default filename key.json, which should be located in the current path where the script is executed.

There are some environment which may be employed to define some options:

Variable	Default
GOOGLE_SPREADSHEET_ID	(none)
GOOGLE_AUTH_FILENAME	key.json

You have two options to use this software:

• Downloading all the sheets. When using with no arguments, it employs the default folder name output and saves the sheets in JSON files under this folder with the name <sheetname>.json.

• Downloading single sheet. When sheetname is defined, then uses this mode downloading only the specified sheet.

In addition to this, when the output filename is not defined via --output, the default filename used is a construction of: output/<sheetname>.json, where sheetname is the sheet name in the Google spreadsheet. Similarly, when the output folder is not defined via --output-folder, the default folder name is output under the current directory where the script is launched.

In case you are using the script from the source folder, you can call it via:

python -m dlgsheet [options] 

Where [options] are the options described above.

In case you have installed, it automatically installs a script to the system path, so you can call as:

dlgsheet [options] 

Licencia

Copyright 2021 Luighi Viton-Zorrilla

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

 http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.