Code Monkey home page Code Monkey logo

beer-analytics's Introduction

beer-analytics ๐Ÿ•ต๏ธ๐Ÿบ

Analyzing the composition of beer recipes and visualize results, built with Django, Pandas and Plotly.

Live website: https://www.beer-analytics.com/

The goal is to expand the knowledge how different beer styles are typically brewed and potentially uncover trends in craft/home brewing.

The project has two components:

  1. a recipe database with reliable data (clean and normalized, reduce outliers and bad data)
  2. a user interface to execute data analysis (filtering, slicing and dicing) and present results in a visually appealing way

Setup

Requirements

  • Python 3.8
  • pip
  • virtualenv (ideally)
  • yarn (JS package manager)

Steps

  • yarn install
  • Initialize virtualenv and enable it
  • Install Python dependencies: pip -r requirements.txt
  • Configure the application (see below)
  • Apply database migrations python makemigrations + python manage.py migrate
  • Load initial data python manage.py load_initial_data

Configuration

Provide a .env file in the beer_analytics folder. An example can be found in beer_analytics/.env.example.

Per default the application starts with "dev" settings. Use DJANGO_SETTINGS_MODULE to use different settings according to the environment:

# Production settings
DJANGO_SETTINGS_MODULE=beer_analytics.settings_prod

# Dev settings
DJANGO_SETTINGS_MODULE=beer_analytics.settings_dev

Recipe data import

After setting up the application, recipes can be imported via CLI in various formats. Each recipe must have a unique id assigned, which can be an arbitrary string.

BeerXML:

python manage.py load_beerxml_recipe recipe.xml unique_id

MMUM format:

python manage.py load_mmum_recipe recipe.json unique_id

BeerSmith format:

python manage.py load_beersmith_recipe recipe.bsmx unique_id

Security

For information about the security policy and know security issues, see SECURITY.md.

Contributing

Want to contribute to this project? See CONTRIBUTING.md.

License

This software is available under the Beerware License.

beer-analytics's People

Contributors

scheb avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.