Skip to content

Sheets Exporter - CLI software for processing and save data from Google Sheets in seconds.

License

Notifications You must be signed in to change notification settings

Insality/sheets-exporter

Repository files navigation

Github-sponsors Ko-Fi BuyMeACoffee

npm

Sheets Exporter - CLI software for processing and save data from Google Sheets in seconds.

See Export Example to get the idea how it's work.

Features

  • Single command to download data from your Google Sheets
  • Save your data in JSON/LUA/CSV format
  • Use default data handlers to change your data in way your need
  • Use your custom handlers for your specific cases
  • Use hashtag # for comment rows or columns in Google Sheets
  • Use <> or [] for make arrays data in Google Sheets (need add convert_array handler)
  • Convert true or false (or Google checkbox values) values to JSON boolean values (need add convert_boolean handler)
  • Separate one Google list for several files (usage example: game localization)
  • Gather data from several Google lists in one file (for easier big data management)
  • Can process local files through handlers

Install

The installation time about 5 minutes ⏱️. Please read the instructions here

Setup configs

Glossary next:

  • Config - contains the google sheets document ID, rules for this document and how to save it.
  • Rule - contains information about which data is collect (lists for Google Sheets or local files) and how it should be processed.

After successful credentials and token setup you can setup sheets-exporter configs:

  • In any folder use sheets-exporter init
    • It will create basic config in default folder: export_config
    • you can move and edit this config if you want, but you need to pass the config path in the next commands otherwise
  • Inside your folder use sheets-exporter add_sheet {sheet_name} {sheet_id}
    • The sheet_name - is the name of Google Sheet document
    • The sheet_id - the Google Sheet document. Gather it from URL. Example: 1V1X5CmbHJOwIu09Oso25H-ephOdYWlAv0xzicp75RT8
  • Inside your folder use sheets-exporter add_rule {sheet_name} {list_name}
    • The sheet_name - the name of config from previous step
    • The list_name - the name of Google Sheet list from document for export.

You can add any amount of rules to your document. After basic setup done, you can check it with sheets-exporter export The sheets-exporter process files inside temp folder and after successful pipeline, upload it to save folder. Check output log:

Upload file /Users/test/export_config/export_result/TokensConfig.json

You can check save folder inside your config.json file.

For more information how edit configs and use default and custom handlers please read the instructions here.

You can check full config example here: Full Config Example

Documentation

To better understand sheets-exporter, read the following documentation:

License

Developed and supported by Insality

Issues and suggestions

If you have any issues, questions or suggestions please create an issue or contact me: insality@gmail.com

❤️ Support project ❤️

Please support me if you like this project! It will help me keep engaged to update this project.

Github-sponsors Ko-Fi BuyMeACoffee

About

Sheets Exporter - CLI software for processing and save data from Google Sheets in seconds.

Topics

Resources

License

Stars

Watchers

Forks