Skip to main content

A BeerXML Parser

Project description

# pybeerxml

A simple BeerXML parser for Python

[![CircleCI](https://circleci.com/gh/hotzenklotz/pybeerxml/tree/master.svg?style=svg)](https://circleci.com/gh/hotzenklotz/pybeerxml/tree/master)
[![PyPi Version](https://img.shields.io/pypi/v/pybeerxml.svg?style=flat-square)](https://pypi.python.org/pypi?:action=display&name=pybeerxml&version=1.0)

Parses all recipes within a BeerXML file and returns <Recipe> object containing all ingredients,
style information and metadata. OG, FG, ABV and IBU are calculated from the ingredient list. (your
milage may vary)

## Installation

```
pip install pybeerxml
```

## Usage

```
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)
```

## Testing

Unit test can be run with PyTest:

```
python setup.py test
```

## License

MIT


Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pybeerxml-1.0.4.tar.gz (5.5 kB view hashes)

Uploaded Source

Built Distribution

pybeerxml-1.0.4-py3-none-any.whl (8.0 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page