Setting up a catalog with Databuoy and Google Sheets

This guide walks through creating a data catalog with Databuoy and Google Sheets. It assumes no knowledge of software development or version control. By the end, you will have a public, searchable data catalog. The steps are:

1. Create a public Google spreadsheet ("Google Sheet") whose contents you control
2. Make a copy of Databuoy's code for your own use
3. Edit your code's data_location file to point to your Google spreadsheet

Step 1: create a public Google Sheet whose contents you control

Databuoy works by pulling in a data catalog from a spreadsheet, and Google Sheets makes collaborating on spreadsheets very easy (you can also use a plain old CSV spreadsheet if you prefer). Here is how to create your own data inventory Google Sheet that will work with Databuoy:

First, register for a Google account, then visit this example spreadsheet.

Next, copy that example spreadsheet into your own Google account:

---

Next, publish your Google spreadsheet to the web (from here on out, this document is public):

---

Step 2: fork the Databuoy repository

Now that you have a public Google spreadsheet, you'll need your own copy of the Databuoy code to show users the spreadsheet's contents.

First, join GitHub if you don't have an account. Choose the free plan. You must confirm your email address; otherwise you'll have to repeat this process.

Next, visit the main Databuoy repository and click "fork":

You now have your own copy of the Databuoy code!

Step 3: Edit your copy of Databuoy's data_location file to point to your Google spreadsheet

Now, all that's left to do is hook up your copy of Databuoy to your Google Sheet.

First, click on the data_location file:

---

Next, click the pencil icon to edit that file:

---

Next, replace the url in the text area with your spreadsheet's published URL (click here for help finding this):

---

Then, save your changes by adding a commit message and clicking "Commit changes":

That's it!

Visit replace_this_part_with_your_github_username.github.io/databuoy, and you should see the data from your sample spreadsheet. Try editing one of the sample rows in your Google Sheet and refreshing your Databuoy URL — if the data updates to reflect your sample spreadsheet's data, everything's all set up!

What's next?

Fill out your spreadsheet with information about your datasets! Click here for guidance on that front.