Skip to content

🍻 An open-source dataset of breweries, cideries, brewpubs, and bottleshops.

License

Notifications You must be signed in to change notification settings

donkeyslaps/openbrewerydb

 
 

🍻 Open Brewery DB Dataset

All Contributors

Open Brewery DB Logo

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.

🗄 Data Formats

🚀 Getting Started

Contributing

  1. Fork the repository
  2. Add or update breweries in the CSV (Excel, Google Sheets)
  3. Submit a Pull Request

Tips

  • CSVs are organized by data/[country]/[state] or data/[country]/[county_province]
  • Required fields/columns: name, street, brewery_type, city, state (or county_province), postal_code, and country
  • Dates are formatted YYYY-MM-DD (NOTE: Be aware that Excel likes to automatically format dates incorrectly)

🚛 Roadmap

Task Status
📤 Release dataset in JSON and CSV
⚙️ Task > Export JSON (/breweries.csv ➡️ /breweries.json)
⚙️ Task > Split CSV (/breweries.csv ➡️ /data)
⚙️ Task > Combine CSV (/data ➡️ /breweries.csv)
⚙️ Github Action > Validate Data
⚙️ Github Action > Update Open Brewery DB API #12
🤖 Unit Tests > Tasks

🤝 Contributing

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

👾 Community

📫 Feedback

Any feedback, please email me.

Cheers! 🍻

Contributors ✨

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

💬 💻 🔣 🚧 📆 🔧

This project follows the all-contributors specification. Contributions of any kind welcome!

About

🍻 An open-source dataset of breweries, cideries, brewpubs, and bottleshops.

Resources

License

Code of conduct

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Jupyter Notebook 72.5%
  • TypeScript 27.5%