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

  • Apprent and Real attenuation calculator

  • Final gravity from a given attenuation percentage

More to come

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.0.7.tar.gz (19.7 kB view details)

Uploaded Source

Built Distribution

brew_tools-0.0.7-py2.py3-none-any.whl (9.8 kB view details)

Uploaded Python 2Python 3

File details

Details for the file brew-tools-0.0.7.tar.gz.

File metadata

  • Download URL: brew-tools-0.0.7.tar.gz
  • Upload date:
  • Size: 19.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.20.0 setuptools/40.5.0 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.6.6

File hashes

Hashes for brew-tools-0.0.7.tar.gz
Algorithm Hash digest
SHA256 086e7b39d4109d6e59fd714a1d858f0b200f93610e6eaacd87447cc6a3fc5f08
MD5 5eaf41f85813f7fd4c895f937f90e69a
BLAKE2b-256 7ca45bc4ef3c0af5c9b2883adcb15815856bed37aa8e81070b8749898cae9983

See more details on using hashes here.

File details

Details for the file brew_tools-0.0.7-py2.py3-none-any.whl.

File metadata

  • Download URL: brew_tools-0.0.7-py2.py3-none-any.whl
  • Upload date:
  • Size: 9.8 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.20.0 setuptools/40.5.0 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.6.6

File hashes

Hashes for brew_tools-0.0.7-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 224e964609e86cc002677a971e3efc667aa156532803daa5191d2c957c061070
MD5 1b55268d6f56da012618d503ed5d9c85
BLAKE2b-256 2c582c93b7a89873172db4239651ff1c4ff550e6f9eebdc7600b007ab9e655ee

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