pybeerxml

A simple BeerXML parser and serializer for Python

Parses all recipes within a BeerXML file and returns Recipe objects containing all ingredients, style information and metadata. OG, FG, ABV and IBU are calculated from the ingredient list. (your milage may vary). Recipes can also be serialized back to BeerXML. All models are built on pydantic and pydantic-xml.

Installation

pip install pybeerxml

Usage

Full documentation is available at pybeerxml.onrender.com.

from pybeerxml import Parser

path_to_beerxml_file = "/tmp/SimcoeIPA.beerxml"

parser = Parser()
recipes = parser.parse(path_to_beerxml_file)

for recipe in recipes:

    # some general recipe properties
    print(recipe.name)
    print(recipe.brewer)

    # calculated properties
    print(recipe.og)
    print(recipe.fg)
    print(recipe.ibu)
    print(recipe.abv)

    # iterate over the ingredients
    for hop in recipe.hops:
        print(hop.name)

    for fermentable in recipe.fermentables:
        print(fermentable.name)

    for yeast in recipe.yeasts:
        print(yeast.name)

    for misc in recipe.miscs:
        print(misc.name)

Serialization

Write recipes back to BeerXML with the Serializer class. Only values stored in the XML-backed fields are written — calculated properties (og_calculated, og_plato, etc.) are never serialized. The stored values for OG, FG, IBU, ABV and color live in the trailing-underscore fields og_, fg_, ibu_, abv_ and color_.

from pybeerxml import Parser, Serializer

parser = Parser()
recipes = parser.parse("/tmp/SimcoeIPA.beerxml")

serializer = Serializer()

# serialize to a string
xml_string = serializer.serialize(recipes)

# or write to a file
serializer.write(recipes, "/tmp/SimcoeIPA-copy.beerxml")

Since all models are pydantic models, you can also build recipes programmatically:

from pybeerxml import Serializer
from pybeerxml.recipe import Recipe
from pybeerxml.hop import Hop

recipe = Recipe(name="My IPA", batch_size=20.0)
recipe.hops.append(Hop(name="Simcoe", alpha=13.0, amount=0.05, use="boil", time=60))

print(recipe.og_calculated)

xml_string = recipe.to_xml_string()

Testing

Unit tests can be run with pytest:

uv run pytest

Contributing / Development

Community contributions are welcome.

Install uv, then sync dependencies:

uv sync

Make sure to test, lint, format, and type-check your code before sending a pull request:

uv run pytest
uv run ruff format .
uv run ruff check .
uv run ty check pybeerxml

License

MIT