🍻 Open Brewery DB Dataset
Provide an approval-based pipeline to update the dataset and API.
🗄 Data Formats
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.
🚀 Getting Started
git clone firstname.lastname@example.org:openbrewerydb/openbrewerydb.git
cd openbrewerydb && npm install
- Fork the repository
- Add or update breweries in the CSV (Excel, Google Sheets)
- Submit a Pull Request
- CSVs are organized by
- Required fields/columns:
These are the npm scripts used to maintain this dataset.
npm run csv:combine- Combine CSVs from country/state-region folders into
npm run csv:split- Split
breweries.csvinto 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
npm run generate:ids- Generate unique OBDB IDs based on the brewery name and city and overwrite
npm run generate:json- Generate JSON from
npm run generate:sql- Generate PostgreSQL SQL from
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.
Thanks goes to these wonderful people (emoji key):
This project follows the all-contributors specification. Contributions of any kind welcome!