sheetwork
Contribute on GitHubChat on Discord
v1.0.3 Nicolas Jaar - Space Is Only Noise
v1.0.3 Nicolas Jaar - Space Is Only Noise
  • Introduction
  • Installation & Configuration
    • Installation & Update
    • Configuration & Authentication
      • Set up your sheetwork project
      • Connecting to Google Sheets
      • Set up your sheetwork profile
  • Usage Configurations
    • Sheet-level Controls (sheets.yml)
      • Basic Configuration
      • Sheet-level Controls Reference
    • Project-level Controls (sheetwork_project.yml)
    • Profile-level Controls (profiles.yml)
  • Commands
    • sheetwork init
    • sheetwork upload
      • upload CLI reference
      • Running sheetwork outside of sheetwork project folders
      • Under the Hood Cleanups
    • Global CLI flags
  • FAQ
    • Do I need to list ALL the columns in my sheets config?
    • Do the column names need to be in the format of the original sheet?
    • What kind of cleanups or reformating does sheetwork do?
    • What datatype casting do you support?
Powered by GitBook
On this page
  1. Installation & Configuration

Configuration & Authentication

PreviousInstallation & UpdateNextSet up your sheetwork project

Last updated 5 years ago

Was this helpful?

CtrlK
  • What is a sheetwork project?
  • Create your `sheetwork_project.yml` file

Was this helpful?

What is a sheetwork project?

A sheetwork project is a simple .yml file that contains some basic information about a collection of sheets you might want to import. It can be located anywhere on your disk but we advise making one folder per project

Create your `sheetwork_project.yml` file

  • First make a project folder, we'll call this one my_sheetwork_project and we'll put it in your home directory but feel free to put it anywhere that makes sense for you:

Now open this file in your editor of choice and configure it as follows:

That's it! Next, we'll set up your connection to the google spreadsheet API

# create a directory
mkdir ~/my_sheetwork_project/
# create an empty sheetwork_project.yml file
touch ~/my_sheetwork_project/sheetwork_project.yml
name: 'my_sheetwork_project' # the name can be anything of your choosing
target_schema: 'sandbox' # optional default schema where you want your sheets to land

# if true, tables will always be created, you can set it to False
# if you would like to control this on every run (check out Running Sheetwork 
# for more info
always_create: true