mirror of
https://github.com/shouptech/humulus.git
synced 2026-02-03 20:59:41 +00:00
116 lines
4.4 KiB
Python
116 lines
4.4 KiB
Python
"""This module has functions for working with BJCP styles."""
|
|
|
|
# Copyright 2019 Mike Shoup
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
# you may not use this file except in compliance with the License.
|
|
# You may obtain a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
# See the License for the specific language governing permissions and
|
|
# limitations under the License.
|
|
|
|
import xml.etree.ElementTree as ET
|
|
|
|
import click
|
|
import requests
|
|
from flask import current_app
|
|
from flask.cli import with_appcontext
|
|
|
|
from humulus.couch import get_db, put_doc
|
|
|
|
def sub_to_doc(sub):
|
|
"""Coverts sub (XML) to a dictionary document.
|
|
|
|
The returned dictionary can be placed right into CouchDB if you want.
|
|
"""
|
|
doc = {
|
|
'_id': 'style_{}'.format(sub.attrib['id']),
|
|
'$type': 'style',
|
|
'id': sub.attrib['id'],
|
|
'name': sub.find('name').text,
|
|
'aroma': sub.find('aroma').text,
|
|
'appearance': sub.find('appearance').text,
|
|
'flavor': sub.find('flavor').text,
|
|
'mouthfeel': sub.find('mouthfeel').text,
|
|
'impression': sub.find('impression').text,
|
|
'ibu': {},
|
|
'og': {},
|
|
'fg': {},
|
|
'srm': {},
|
|
'abv': {}
|
|
}
|
|
if sub.find('comments') is not None:
|
|
doc['comments'] = sub.find('comments').text
|
|
if sub.find('history') is not None:
|
|
doc['history'] = sub.find('history').text
|
|
if sub.find('ingredients') is not None:
|
|
doc['ingredients'] = sub.find('ingredients').text
|
|
if sub.find('comparison') is not None:
|
|
doc['comparison'] = sub.find('comparison').text
|
|
if sub.find('examples') is not None:
|
|
doc['examples'] = sub.find('examples').text
|
|
if sub.find('tags') is not None:
|
|
doc['tags'] = sub.find('tags').text.split(', ')
|
|
|
|
doc['ibu']['low'] = (sub.find('./stats/ibu/low').text
|
|
if sub.find('./stats/ibu/low') is not None else '0')
|
|
doc['ibu']['high'] = (sub.find('./stats/ibu/high').text
|
|
if sub.find('./stats/ibu/high') is not None else '100')
|
|
doc['og']['low'] = (sub.find('./stats/og/low').text
|
|
if sub.find('./stats/og/low') is not None else '1.0')
|
|
doc['og']['high'] = (sub.find('./stats/og/high').text
|
|
if sub.find('./stats/og/high') is not None else '1.2')
|
|
doc['fg']['low'] = (sub.find('./stats/fg/low').text
|
|
if sub.find('./stats/fg/low') is not None else '1.0')
|
|
doc['fg']['high'] = (sub.find('./stats/fg/high').text
|
|
if sub.find('./stats/fg/high') is not None else '1.2')
|
|
doc['srm']['low'] = (sub.find('./stats/srm/low').text
|
|
if sub.find('./stats/srm/low') is not None else '0')
|
|
doc['srm']['high'] = (sub.find('./stats/srm/high').text
|
|
if sub.find('./stats/srm/high') is not None else '100')
|
|
doc['abv']['low'] = (sub.find('./stats/abv/low').text
|
|
if sub.find('./stats/abv/low') is not None else '0')
|
|
doc['abv']['high'] = (sub.find('./stats/abv/high').text
|
|
if sub.find('./stats/abv/high') is not None else '100')
|
|
return doc
|
|
|
|
|
|
def import_styles(url):
|
|
"""Parses BJCP styles in XML format from `url`.
|
|
|
|
`url` defaults to the official BJCP XML styleguide.
|
|
|
|
Each subcategory is converted to JSON and then put to a couchdb. The _id of
|
|
the subsequent document will be `style_<number><letter>`, i.e., style_1A.
|
|
If the style already exists in the database, it will be skipped.
|
|
"""
|
|
db = get_db()
|
|
root = ET.fromstring(requests.get(url).text)
|
|
subs = root.findall('./class[@type="beer"]/category/subcategory')
|
|
for sub in subs:
|
|
doc = sub_to_doc(sub)
|
|
if doc['_id'] not in db:
|
|
put_doc(doc)
|
|
|
|
|
|
@click.command('import-styles')
|
|
@with_appcontext
|
|
def import_command():
|
|
"""CLI command to import BJCP styles."""
|
|
url = current_app.config.get(
|
|
'BJCP_STYLES_URL',
|
|
('https://raw.githubusercontent.com/meanphil'
|
|
'/bjcp-guidelines-2015/master/styleguide.xml')
|
|
)
|
|
import_styles(url)
|
|
click.echo("Imported BJCP styles.")
|
|
|
|
|
|
def init_app(app):
|
|
"""Register the CLI command with the app."""
|
|
app.cli.add_command(import_command)
|