🍻 Open Brewery DB Dataset

This is the open-source dataset for the Open Brewery DB API which is served by a REST API built with Ruby on Rails

🎯 Purpose

Provide an approval-based pipeline to update the dataset and API.

Access the dataset programmatically via the Open Brewery DB API. Use the following tools to get started without any code:

If you don't know how to use APIs, you can use Brewery DB without code through the databar.ai platform.

A shared Postman collection containing all the API requests to fetch breweries information from the open-source dataset.

For information on contributing to this project, please see the contributing guide and our code of conduct.

First and foremost, don't worry about messing up! 🙂 Thank you so much for contributing! 🙌

CSVs are organized by data/[country]/[state_province]
Required fields/columns: name, brewery_type, city, state_province, postal_code, and country
When adding a brewery, do not include an id. This will be created after review.
Please either add to breweries.csv (preferred if adding breweries for a new country) or the individual state/province CSV file. Adding to both at the same time may introduce duplicates/errors.

These are the npm scripts used to maintain this dataset.

npm run csv:combine - Combine CSVs from country/state-region folders into breweries.csv
npm run csv:split - Split breweries.csv into country/state-region/city CSVs
npm run contributors:add - Add contributor (interactive CLI)
npm run contributors:check - Check if there are any missing contributors
npm run contributors:generate - Generate contributors into README.md
npm run generate:ids - Generate unique OBDB IDs based on the brewery name and city and overwrite breweries.csv
npm run generate:json - Generate JSON from breweries.csv output to breweries.json
npm run generate:sql - Generate PostgreSQL SQL from breweries.csv output to breweries.sql
npm run validate - Validate CSVs based on JSON Schema
npm run workflow:maintain - Combine, generate, split (used when updating individual CSVs)

Any feedback, please email me.

Cheers! 🍻

Thanks goes to these wonderful people (emoji key):

_{Mike Putnam} 🔣	_{Andrew A. Barber} 🔣	_{Jason Allen} 🔣	_Juicob 🔣	_{Will Karnasiewicz} 🔣	_{Dylan T. Vavra} 🔣	_{Madison Martinez} 🔣
_{Daniel Eremchuk} 🔣	_{Alex Chong} 🔣	_{Matt S} 🔣	_{Samuel Rusher} 🔣	_{Evan Caraway} 🔣	_{Tyler K Kuromiya Parker} 🔣	_{kendellmendoza} 🔣
_Johnnyk737 🔣	_{James Schuler} 🔣	_{Creighton Leif} 🔣	_{Vitaly Tomilov} 💻	_{Kyle Scudder} 🔣	_{Chris Mears} 💬 💻 🔣 🚧 📆 🔧 ✅	_donkeyslaps 🔣
_{Pranav Davar} 🔧	_{Alexandre Hernandes Barrozo} 🔣	_Resten 🔣	_{Matt Higgins} 🔣	_{Alex Justesen} 🔣	_{Craig Kelly} 🔣	_{Krzysztof Rewak} 🔣
_{John Baumert} 🔣	_{Charlie Cox} 🔣	_{Miles Kane} 🔣	_{Anthony Laflamme} 💻	_{Georg Engelsmann} 🔣	_{Clinton Williams} 🔣	_{Brent Busby} 🔣