motherjones / grunt-gss-pull

Grabs data from a google spreadsheet, writes it as a json file.
MIT License
15 stars 4 forks source link

grunt-gss-pull

Pulls data from a published google spreadsheet and saves it as json locally. Yes. Published. Not public, published.

Getting Started

If you haven't used grunt before, be sure to check out the Getting Started guide.

From the same directory as your project's Gruntfile and package.json, install this plugin with the following command:

npm install grunt-gss-pull --save-dev

Once that's done, add this line to your project's Gruntfile:

grunt.loadNpmTasks('grunt-gss-pull');

If the plugin has been installed correctly, running grunt --help at the command line should list the newly-installed plugin's task or tasks. In addition, the plugin should be listed in package.json as a devDependency, which ensures that it will be installed whenever the npm install command is run.

The "gss_pull" task

Overview

In your project's Gruntfile, add a section named gss_pull to the data object passed into grunt.initConfig().

grunt.initConfig({
  gss_pull: {
    your_target: {
        files: {
            'path/to/your.json' : ['google spreadsheet key']
        },
    },
  },
})

You should be able to then type grunt gss_pull, and grab the data out of the spreadsheet specified, and have it written as json.

Contributing

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using grunt.

Release History

(Nothing yet)