Skip to main content

Commandline tools for the homebrewer

Project description

brew-tools

╔╗ ╦═╗╔═╗╦ ╦  ╔╦╗╔═╗╔═╗╦  ╔═╗
╠╩╗╠╦╝║╣ ║║║───║ ║ ║║ ║║  ╚═╗
╚═╝╩╚═╚═╝╚╩╝   ╩ ╚═╝╚═╝╩═╝╚═╝

Build Status Documentation Status PyPI version

A command line utility that offers a set of calculators for home brewers.

NOTE: All values and calculations are provided as guidelines only. Brew-tools should not be used for professional brewing. No warranty or guarantee of accuracy is provided on the information provided by this calculator.

Description

Need to do a quick calculation during your brew day? Don’t fancy digging through a GUI application, or a web based tool? Prefer to do simple things in a terminal?

Then brew-tools is for you.

Currently brew-tools includes:

  • ABV calculator

  • Keg priming calculator

  • Priming sugar calculator

  • Quick infusion calculator

  • Adjust gravity with dme calculator

  • Apparent and Real attenuation calculator

  • Final gravity from a given attenuation percentage

  • Gravity adjustment by boil off/dilution calculator

  • New gravity after volume adjustment

More to come

See the changelog for updates in each version

Installation

Brew-tools is available from PyPI

pip install brew-tools

You can also clone/download this repository and install it using pip

cd <brew-tools-dir>
pip install .

Usage

Brew tools has built in help

Usage: brew-tools [OPTIONS] COMMAND [ARGS]...

Options:
--version  Show the version and exit.
-imperial  Use imperial units. Metric by default.
--help     Show this message and exit.

Commands:
abv
infuse
kegpsi
prime
dme

and also for its commands

brew-tools infuse --help
Usage: brew-tools infuse [OPTIONS]

Options:
  -temp FLOAT    Current temperature of mash
  -target FLOAT  Target temperature of mash
  -ratio FLOAT   Grist/water ratio
  -grain FLOAT   Weight of grain in mash
  -water FLOAT   Temp of infusion water
  --help         Show this message and exit.

If the inputs are not passed via the command line arguments, brew tools will prompt the user for input.

For more information see the documentation

Development

If you want to help develop brew tools you should install it into a virtual environment.

Create and source the environment and then install brew tools with

cd <brew-tools project dir>
pip install -e ".[testing]"

which will install an editable version, as well as all the tools required to run the tests with

pytest tests

In addition to the tests it’s advisable to run a linter of the source as Travis will also check for linting errors. The linter command ignores some errors, so you can use this command to match the command run by Travis

flake8 src --ignore=E501,W504,W503

Thanks

Thanks to

  • /u/DAMNIT_REZNO - for inspiring me to start this project

  • SlayterDev - DME addition calculator

License

Brew Tools is released under the MIT license.

See LICENSE.txt for more details

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

brew_tools-0.2.3.tar.gz (10.8 kB view details)

Uploaded Source

Built Distribution

brew_tools-0.2.3-py3-none-any.whl (10.7 kB view details)

Uploaded Python 3

File details

Details for the file brew_tools-0.2.3.tar.gz.

File metadata

  • Download URL: brew_tools-0.2.3.tar.gz
  • Upload date:
  • Size: 10.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/0.12.16 CPython/3.7.3 Linux/4.15.0-52-generic

File hashes

Hashes for brew_tools-0.2.3.tar.gz
Algorithm Hash digest
SHA256 2fc8e1e0d5ad61a3b7fe4f0ed61de983648c277d6ec3022aa58932f5f0fb9ea0
MD5 44f85aeab71daff25914e1b157fc16f4
BLAKE2b-256 a911ddae758a350063807819a257a4823b1d92988b7b23401642606304be0f2f

See more details on using hashes here.

File details

Details for the file brew_tools-0.2.3-py3-none-any.whl.

File metadata

  • Download URL: brew_tools-0.2.3-py3-none-any.whl
  • Upload date:
  • Size: 10.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/0.12.16 CPython/3.7.3 Linux/4.15.0-52-generic

File hashes

Hashes for brew_tools-0.2.3-py3-none-any.whl
Algorithm Hash digest
SHA256 ef1f630ee7e9221e1ae8a5043debd5fd8362befcebf619f2f44310ef5b3da39d
MD5 c622d801f9a6f5921211853cc29b6207
BLAKE2b-256 90b7f0fdc88551fb33748de2487f31ec010c60da27d9dcde4cbfcdda1dce2859

See more details on using hashes here.

Supported by

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