<div align="center">
<img src="https://github.com/sepandhaghighi/mycoffee/raw/main/otherfiles/logo.png" width="500">
<h1>MyCoffee: Brew Perfect Coffee Right from Your Terminal</h1>
<br/>
<a href="https://www.python.org/"><img src="https://img.shields.io/badge/built%20with-Python3-green.svg" alt="built with Python3"></a>
<a href="https://github.com/sepandhaghighi/mycoffee"><img alt="GitHub repo size" src="https://img.shields.io/github/repo-size/sepandhaghighi/mycoffee"></a>
<a href="https://badge.fury.io/py/mycoffee"><img src="https://badge.fury.io/py/mycoffee.svg" alt="PyPI version"></a>
<a href="https://codecov.io/gh/sepandhaghighi/mycoffee" ><img src="https://codecov.io/gh/sepandhaghighi/mycoffee/graph/badge.svg?token=ZelznFDSPA"></a>
</div>
## Overview
<p align="justify">
<strong>MyCoffee</strong> is a command-line tool for coffee enthusiasts who love brewing with precision. It helps you calculate the perfect coffee-to-water ratio for various brewing methods, ensuring you brew your ideal cup every time-right from your terminal.
</p>
<table>
<tr>
<td align="center">PyPI Counter</td>
<td align="center"><a href="http://pepy.tech/project/mycoffee"><img src="http://pepy.tech/badge/mycoffee"></a></td>
</tr>
<tr>
<td align="center">Github Stars</td>
<td align="center"><a href="https://github.com/sepandhaghighi/mycoffee"><img src="https://img.shields.io/github/stars/sepandhaghighi/mycoffee.svg?style=social&label=Stars"></a></td>
</tr>
</table>
<table>
<tr>
<td align="center">Branch</td>
<td align="center">main</td>
<td align="center">dev</td>
</tr>
<tr>
<td align="center">CI</td>
<td align="center"><img src="https://github.com/sepandhaghighi/mycoffee/actions/workflows/test.yml/badge.svg?branch=main"></td>
<td align="center"><img src="https://github.com/sepandhaghighi/mycoffee/actions/workflows/test.yml/badge.svg?branch=dev"></td>
</tr>
</table>
<table>
<tr>
<td align="center">Code Quality</td>
<td align="center"><a href="https://www.codefactor.io/repository/github/sepandhaghighi/mycoffee"><img src="https://www.codefactor.io/repository/github/sepandhaghighi/mycoffee/badge" alt="CodeFactor"></a></td>
<td align="center"><a href="https://codebeat.co/projects/github-com-sepandhaghighi-mycoffee-main"><img alt="codebeat badge" src="https://codebeat.co/badges/8cb2671b-7640-4ac7-bb3e-823bb26a2db2"></a></td>
<td align="center"><a href="https://app.codacy.com/gh/sepandhaghighi/mycoffee/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade"><img src="https://app.codacy.com/project/badge/Grade/ac0a8041879042d4a7925272ea3f7ba5"></a></td>
</tr>
</table>
## Installation
### Source Code
- Download [Version 1.5](https://github.com/sepandhaghighi/mycoffee/archive/v1.5.zip) or [Latest Source](https://github.com/sepandhaghighi/mycoffee/archive/dev.zip)
- `pip install .`
### PyPI
- Check [Python Packaging User Guide](https://packaging.python.org/installing/)
- `pip install mycoffee==1.5`
## Usage
ℹ️ You can use `mycoffee` or `python -m mycoffee` to run this program
### Version
```console
> mycoffee --version
1.5
```
### Info
```console
> mycoffee --info
__ __ ____ __ __
| \/ | _ _ / ___| ___ / _| / _| ___ ___
| |\/| || | | || | / _ \ | |_ | |_ / _ \ / _ \
| | | || |_| || |___ | (_) || _|| _|| __/| __/
|_| |_| \__, | \____| \___/ |_| |_| \___| \___|
|___/
__ __ _ ____
\ \ / / _ / | | ___|
\ \ / / (_)| | |___ \
\ V / _ | | _ ___) |
\_/ (_)|_|(_)|____/
MyCoffee is a command-line tool for coffee enthusiasts who love brewing with precision.
It helps you calculate the perfect coffee-to-water ratio for various brewing methods,
ensuring you brew your ideal cup every time-right from your terminal.
Repo : https://github.com/sepandhaghighi/mycoffee
```
### Method
```console
> mycoffee --method=v60
__ __ _ _ ___ _____ ____ ____ ____ ____
( \/ )( \/ ) / __)( _ )( ___)( ___)( ___)( ___)
) ( \ / ( (__ )(_)( )__) )__) )__) )__)
(_/\/\_) (__) \___)(_____)(__) (__) (____)(____)
Method: `v60`
Cups: 1
Coffee: 15 g
Water: 250 g
Ratio: 3/50
Grind: 550 um (Medium-Fine)
Temperature: 91 C
Message: V60 method
```
* [Methods List](https://github.com/sepandhaghighi/mycoffee/blob/main/METHODS.md)
* `mycoffee --methods-list`
### Customize
ℹ️ You can run `mycoffee --coffee-units-list` to view the supported coffee units
ℹ️ You can run `mycoffee --water-units-list` to view the supported water units
```console
> mycoffee --method=chemex --water=20 --cups=3 --coffee-ratio=2 --water-ratio=37 --coffee-unit="t oz" --water-unit="fl oz" --grind=750 --temperature=88
__ __ _ _ ___ _____ ____ ____ ____ ____
( \/ )( \/ ) / __)( _ )( ___)( ___)( ___)( ___)
) ( \ / ( (__ )(_)( )__) )__) )__) )__)
(_/\/\_) (__) \___)(_____)(__) (__) (____)(____)
Method: `chemex`
Cups: 3
Coffee: 3.084 t oz
Water: 20 fl oz
Ratio: 2/37
Grind: 750 um (Medium)
Temperature: 88 C
Message: Chemex method
```
## Parameters
<table>
<thead>
<tr>
<th align="center">Parameter</th>
<th align="center">Description</th>
<th align="center">Type</th>
<th align="center">Default</th>
</tr>
</thead>
<tbody>
<tr>
<td align="center"><code>--method</code></td>
<td align="center">Specifies the coffee brewing method</td>
<td align="center">String</td>
<td align="center"><code>custom</code></td>
</tr>
<tr>
<td align="center"><code>--water</code></td>
<td align="center">Sets the amount of water in each cup</td>
<td align="center">Positive float</td>
<td align="center"><code>240</code></td>
</tr>
<tr>
<td align="center"><code>--cups</code></td>
<td align="center">Indicates the number of cups</td>
<td align="center">Positive integer</td>
<td align="center"><code>1</code></td>
</tr>
<tr>
<td align="center"><code>--grind</code></td>
<td align="center">Grind size (um)</td>
<td align="center">Positive integer</td>
<td align="center"><code>700</code></td>
</tr>
<tr>
<td align="center"><code>--temperature</code></td>
<td align="center">Brewing temperature</td>
<td align="center">Float</td>
<td align="center"><code>90</code></td>
</tr>
<tr>
<td align="center"><code>--coffee-ratio</code></td>
<td align="center">Coefficient for the coffee component in the ratio</td>
<td align="center">Positive float</td>
<td align="center"><code>1</code></td>
</tr>
<tr>
<td align="center"><code>--water-ratio</code></td>
<td align="center">Coefficient for the water component in the ratio</td>
<td align="center">Positive float</td>
<td align="center"><code>17</code></td>
</tr>
<tr>
<td align="center"><code>--message</code></td>
<td align="center">Extra information about the brewing method</td>
<td align="center">String</td>
<td align="center"><code>Custom brewing method</code></td>
</tr>
<tr>
<td align="center"><code>--digits</code></td>
<td align="center">Number of digits up to which the result is rounded</td>
<td align="center">Integer</td>
<td align="center"><code>3</code></td>
</tr>
<tr>
<td align="center"><code>--coffee-unit</code></td>
<td align="center">Coffee unit</td>
<td align="center">String</td>
<td align="center"><code>g</code></td>
</tr>
<tr>
<td align="center"><code>--water-unit</code></td>
<td align="center">Water unit</td>
<td align="center">String</td>
<td align="center"><code>g</code></td>
</tr>
<tr>
<td align="center"><code>--temperature-unit</code></td>
<td align="center">Temperature unit</td>
<td align="center">String</td>
<td align="center"><code>C</code></td>
</tr>
</tbody>
</table>
## Issues & Bug Reports
Just fill an issue and describe it. We'll check it ASAP!
- Please complete the issue template
## References
<blockquote>1- <a href="https://honestcoffeeguide.com/coffee-to-water-ratio-calculator/">Coffee to water ratio calculator</a></blockquote>
<blockquote>2- <a href="https://www.origincoffee.co.uk/blogs/journal/brewing-at-home-v60">V60 Brew Guide</a></blockquote>
<blockquote>3- <a href="https://unionroasted.com/blogs/brewing-guides/chemex-pour-over">How to Brew Coffee with a Chemex</a></blockquote>
<blockquote>4- <a href="https://www.illy.com/en-us/coffee/coffee-preparation/how-to-use-a-french-press">Using French press for perfect coffee</a></blockquote>
<blockquote>5- <a href="https://www.haymancoffee.com/blogs/coffee-blog/how-to-brew-the-perfect-cup-of-siphon-coffee">How to Brew the Perfect Cup of Siphon Coffee</a></blockquote>
<blockquote>6- <a href="https://home.lamarzoccousa.com/using-espresso-brew-ratios/">Using Espresso Brew Ratios</a></blockquote>
<blockquote>7- <a href="https://www.nicolebattefeld.com/post/best-recipes-2022">My Best Coffee Recipes of 2022</a></blockquote>
<blockquote>8- <a href="https://wonderstate.com/pages/auto-drip">Auto Drip Brewing Guide</a></blockquote>
<blockquote>9- <a href="https://counterculturecoffee.com/blogs/counter-culture-coffee/guide-to-cold-brew">Guide To Cold Brew</a></blockquote>
<blockquote>10- <a href="https://www.thespruceeats.com/cold-brew-concentrate-recipe-5197494">Cold Brew Concentrate Recipe</a></blockquote>
<blockquote>11- <a href="https://bakedbrewedbeautiful.com/how-to-make-coffee-in-moka-pot/">How to Make Coffee in a Moka Pot</a></blockquote>
<blockquote>12- <a href="https://www.drinktrade.com/blogs/education/how-to-make-turkish-coffee">How to Make Turkish Coffee at Home</a></blockquote>
<blockquote>13- <a href="https://www.horshamcoffeeroaster.co.uk/pages/how-to-cup-coffee">How to Cup Coffee</a></blockquote>
<blockquote>14- <a href="https://aeroprecipe.com/recipes/tetsu-kasuya-aeropress-recipe">Tetsu Kasuya AeroPress Recipe</a></blockquote>
<blockquote>15- <a href="https://aeroprecipe.com/recipes/all-about-the-intervals">All about the intervals</a></blockquote>
<blockquote>16- <a href="https://squaremileblog.com/brew-guide-clever-dripper/">Clever Dripper; Square Mile Coffee</a></blockquote>
<blockquote>17- <a href="https://www.seattlecoffeegear.com/pages/product-resource/aero-press-product-resources">AeroPress Product User Manuals</a></blockquote>
<blockquote>18- <a href="https://www.rapidtables.com/convert/weight/index.html">RapidTables - Weight Converter</a></blockquote>
<blockquote>19- <a href="https://honestcoffeeguide.com/whole-bean-to-ground-coffee-ratio/">Whole bean to ground coffee calculator</a></blockquote>
<blockquote>20- <a href="https://www.howmany.wiki/wv/">Weight to Volume Converter for Recipes</a></blockquote>
<blockquote>21- <a href="https://chamberlaincoffee.com/blogs/inspiration/how-much-coffee-per-cup-this-is-how-you-get-it-right">How Much Coffee per Cup?</a></blockquote>
<blockquote>22- <a href="https://www.calculator.net/weight-calculator.html">Weight Calculator</a></blockquote>
<blockquote>23- <a href="https://www.inchcalculator.com/convert/volume/">Volume Conversion Calculator - Inch Calculator</a></blockquote>
<blockquote>24- <a href="https://www.metric-conversions.org/">Metric Conversion Charts and Calculators</a></blockquote>
<blockquote>25- <a href="https://honestcoffeeguide.com/coffee-grind-size-chart">Coffee grind size chart</a></blockquote>
<blockquote>26- <a href="https://honestcoffeeguide.com/best-temperature-to-brew-coffee/">The best temperature to brew coffee</a></blockquote>
<blockquote>27- <a href="https://unionroasted.com/blogs/brewing-guides/syphon">How to Brew Coffee with a Syphon</a></blockquote>
<blockquote>28- <a href="https://counterculturecoffee.com/blogs/counter-culture-coffee/guide-to-home-coffee-makers">Guide To Home Coffee Makers</a></blockquote>
<blockquote>29- <a href="https://perfectdailygrind.com/2021/07/can-you-brew-coffee-with-warm-water">Can you brew coffee with warm water?</a></blockquote>
<blockquote>30- <a href="https://ravecoffee.co.uk/blogs/news/how-to-brew-coffee-using-an-ibrik-cezve-for-turkish-style-coffee">How to Brew Coffee Using a Cezve</a></blockquote>
<blockquote>31- <a href="https://www.diffordsguide.com/g/1113/coffee/cupping">Coffee cupping</a></blockquote>
## Show Your Support
<h3>Star This Repo</h3>
Give a ⭐️ if this project helped you!
<h3>Donate to Our Project</h3>
<h4>Bitcoin</h4>
1KtNLEEeUbTEK9PdN6Ya3ZAKXaqoKUuxCy
<h4>Ethereum</h4>
0xcD4Db18B6664A9662123D4307B074aE968535388
<h4>Litecoin</h4>
Ldnz5gMcEeV8BAdsyf8FstWDC6uyYR6pgZ
<h4>Doge</h4>
DDUnKpFQbBqLpFVZ9DfuVysBdr249HxVDh
<h4>Tron</h4>
TCZxzPZLcJHr2qR3uPUB1tXB6L3FDSSAx7
<h4>Ripple</h4>
rN7ZuRG7HDGHR5nof8nu5LrsbmSB61V1qq
<h4>Binance Coin</h4>
bnb1zglwcf0ac3d0s2f6ck5kgwvcru4tlctt4p5qef
<h4>Tether</h4>
0xcD4Db18B6664A9662123D4307B074aE968535388
<h4>Dash</h4>
Xd3Yn2qZJ7VE8nbKw2fS98aLxR5M6WUU3s
<h4>Stellar</h4>
GALPOLPISRHIYHLQER2TLJRGUSZH52RYDK6C3HIU4PSMNAV65Q36EGNL
<h4>Zilliqa</h4>
zil1knmz8zj88cf0exr2ry7nav9elehxfcgqu3c5e5
<h4>Coffeete</h4>
<a href="http://www.coffeete.ir/opensource">
<img src="http://www.coffeete.ir/images/buttons/lemonchiffon.png" style="width:260px;" />
</a>
# Changelog
All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
## [Unreleased]
## [1.5] - 2025-02-26
### Added
- `--info` argument
- `--ignore-warnings` argument
- `--temperature-unit` argument
- `--temperature-units-list` argument
### Changed
- Test system modified
- `README.md` updated
## [1.4] - 2025-02-15
### Added
- `--temperature` argument
- Temperature upper limit
- Temperature lower limit
### Changed
- `--info` argument renamed to `--message`
- Warning messages updated
- `README.md` updated
- `METHODS.md` updated
## [1.3] - 2025-01-31
### Added
- `get_grind_type` function
- `validate_positive_int` function
- `validate_positive_float` function
### Changed
- `README.md` updated
- `check_ratio_limits` function bug fixed
- String templates modified
- Test system modified
## [1.2] - 2025-01-13
### Added
- 2 new water units
1. Troy Pounds (`t lb`)
2. Pennyweight (`dwt`)
- 2 new coffee units
1. Troy Pounds (`t lb`)
2. Pennyweight (`dwt`)
- `--grind` argument
- Grind upper limit
- Grind lower limit
- `check_grind_limits` function
### Changed
- `README.md` updated
- `METHODS.md` updated
## [1.1] - 2025-01-02
### Added
- 5 new water units
1. Troy Ounce (`t oz`)
2. Grain (`gr`)
3. Carats (`ct`)
4. Cubic Centimeters (`cc`)
5. Centiliters (`cl`)
- 3 new coffee units
1. Troy Ounce (`t oz`)
2. Grain (`gr`)
3. Carats (`ct`)
### Changed
- `README.md` updated
## [1.0] - 2024-12-17
### Added
- 3 new water units
1. Pint (`pt`)
2. Quart (`qt`)
3. Fluid Ounce (`fl oz`)
### Changed
- `README.md` updated
## [0.9] - 2024-12-06
### Added
- 4 new water units
1. Tablespoon (`tbsp`)
2. Teaspoon (`tsp`)
3. Dessertspoon (`dsp`)
4. Cup (`cup`)
## [0.8] - 2024-11-29
### Added
- 1 new coffee unit
1. Cup (`cup`)
- 6 new water units
1. Milliliter (`ml`)
2. Liter (`l`)
3. Ounce (`oz`)
4. Pound (`lb`)
5. Milligram (`mg`)
6. Kilogram (`kg`)
- `convert_water` function
- `show_water_units_list` function
- `--water-unit` argument
### Changed
- Test system modified
- `README.md` updated
## [0.7] - 2024-11-21
### Added
- 4 new coffee units
1. Coffee beans (`cb`)
2. Tablespoon (`tbsp`)
3. Teaspoon (`tsp`)
4. Dessertspoon (`dsp`)
- `convert_coffee` function
### Changed
- GitHub actions are limited to the `dev` and `main` branches
## [0.6] - 2024-10-18
### Added
- `show_coffee_units_list` function
- `--coffee-unit` argument
### Changed
- Test system modified
- Cups bug fixed
- `calc_coffee` function updated
- `README.md` updated
- `Python 3.13` added to `test.yml`
## [0.5] - 2024-10-08
### Added
- Ratio upper limit
- Ratio lower limit
- `check_ratio_limits` function
### Changed
- Test system modified
- `print_message` function renamed to `print_result`
## [0.4] - 2024-10-01
### Added
- 4 new methods
1. AeroPress standard
2. AeroPress concentrate
3. AeroPress inverted
4. Steep-and-release
- `--digits` argument
### Changed
- `README.md` updated
- Test system modified
- `filter_params` function updated
## [0.3] - 2024-09-24
### Added
- Logo
- 4 new methods
1. Ristretto
2. Lungo
3. Turkish
4. Cupping
## [0.2] - 2024-09-17
### Added
- 5 new methods
1. Pour-over
2. Auto drip
3. Cold brew
4. Cold brew concentrate
5. Moka pot
- `is_int` function
- `filter_params` function
### Changed
- `README.md` updated
- `--coffee-ratio` type changed from `int` to `float`
- `--water-ratio` type changed from `int` to `float`
- `coffee_calc` function renamed to `calc_coffee`
- `print_message` function updated
- Test system modified
## [0.1] - 2024-09-02
### Added
- 6 new methods
1. V60
2. Espresso
3. Chemex
4. French-press
5. Siphon
6. Custom
[Unreleased]: https://github.com/sepandhaghighi/mycoffee/compare/v1.5...dev
[1.5]: https://github.com/sepandhaghighi/mycoffee/compare/v1.4...v1.5
[1.4]: https://github.com/sepandhaghighi/mycoffee/compare/v1.3...v1.4
[1.3]: https://github.com/sepandhaghighi/mycoffee/compare/v1.2...v1.3
[1.2]: https://github.com/sepandhaghighi/mycoffee/compare/v1.1...v1.2
[1.1]: https://github.com/sepandhaghighi/mycoffee/compare/v1.0...v1.1
[1.0]: https://github.com/sepandhaghighi/mycoffee/compare/v0.9...v1.0
[0.9]: https://github.com/sepandhaghighi/mycoffee/compare/v0.8...v0.9
[0.8]: https://github.com/sepandhaghighi/mycoffee/compare/v0.7...v0.8
[0.7]: https://github.com/sepandhaghighi/mycoffee/compare/v0.6...v0.7
[0.6]: https://github.com/sepandhaghighi/mycoffee/compare/v0.5...v0.6
[0.5]: https://github.com/sepandhaghighi/mycoffee/compare/v0.4...v0.5
[0.4]: https://github.com/sepandhaghighi/mycoffee/compare/v0.3...v0.4
[0.3]: https://github.com/sepandhaghighi/mycoffee/compare/v0.2...v0.3
[0.2]: https://github.com/sepandhaghighi/mycoffee/compare/v0.1...v0.2
[0.1]: https://github.com/sepandhaghighi/mycoffee/compare/c2d0bb4...v0.1
Raw data
{
"_id": null,
"home_page": "https://github.com/sepandhaghighi/mycoffee",
"name": "mycoffee",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": "coffee ratio terminal brew cli",
"author": "Sepand Haghighi",
"author_email": "me@sepand.tech",
"download_url": "https://files.pythonhosted.org/packages/58/13/98d8ebcbe2845a3625857593763f475377195a2d23b753106fd4e7650c5a/mycoffee-1.5.tar.gz",
"platform": null,
"description": "\n<div align=\"center\">\n<img src=\"https://github.com/sepandhaghighi/mycoffee/raw/main/otherfiles/logo.png\" width=\"500\">\n<h1>MyCoffee: Brew Perfect Coffee Right from Your Terminal</h1>\n<br/>\n<a href=\"https://www.python.org/\"><img src=\"https://img.shields.io/badge/built%20with-Python3-green.svg\" alt=\"built with Python3\"></a>\n<a href=\"https://github.com/sepandhaghighi/mycoffee\"><img alt=\"GitHub repo size\" src=\"https://img.shields.io/github/repo-size/sepandhaghighi/mycoffee\"></a>\n<a href=\"https://badge.fury.io/py/mycoffee\"><img src=\"https://badge.fury.io/py/mycoffee.svg\" alt=\"PyPI version\"></a>\n<a href=\"https://codecov.io/gh/sepandhaghighi/mycoffee\" ><img src=\"https://codecov.io/gh/sepandhaghighi/mycoffee/graph/badge.svg?token=ZelznFDSPA\"></a>\n</div>\t\t\t\n\t\t\t\t\n## Overview\t\n\n<p align=\"justify\">\t\t\t\t\t\n<strong>MyCoffee</strong> is a command-line tool for coffee enthusiasts who love brewing with precision. It helps you calculate the perfect coffee-to-water ratio for various brewing methods, ensuring you brew your ideal cup every time-right from your terminal.\n</p>\n\n<table>\n\t<tr>\n\t\t<td align=\"center\">PyPI Counter</td>\n\t\t<td align=\"center\"><a href=\"http://pepy.tech/project/mycoffee\"><img src=\"http://pepy.tech/badge/mycoffee\"></a></td>\n\t</tr>\n\t<tr>\n\t\t<td align=\"center\">Github Stars</td>\n\t\t<td align=\"center\"><a href=\"https://github.com/sepandhaghighi/mycoffee\"><img src=\"https://img.shields.io/github/stars/sepandhaghighi/mycoffee.svg?style=social&label=Stars\"></a></td>\n\t</tr>\n</table>\n\n\n\n<table>\n\t<tr> \n\t\t<td align=\"center\">Branch</td>\n\t\t<td align=\"center\">main</td>\t\n\t\t<td align=\"center\">dev</td>\t\n\t</tr>\n\t<tr>\n\t\t<td align=\"center\">CI</td>\n\t\t<td align=\"center\"><img src=\"https://github.com/sepandhaghighi/mycoffee/actions/workflows/test.yml/badge.svg?branch=main\"></td>\n\t\t<td align=\"center\"><img src=\"https://github.com/sepandhaghighi/mycoffee/actions/workflows/test.yml/badge.svg?branch=dev\"></td>\n\t</tr>\n</table>\n\n\n<table>\n\t<tr> \n\t\t<td align=\"center\">Code Quality</td>\n\t\t<td align=\"center\"><a href=\"https://www.codefactor.io/repository/github/sepandhaghighi/mycoffee\"><img src=\"https://www.codefactor.io/repository/github/sepandhaghighi/mycoffee/badge\" alt=\"CodeFactor\"></a></td>\n\t\t<td align=\"center\"><a href=\"https://codebeat.co/projects/github-com-sepandhaghighi-mycoffee-main\"><img alt=\"codebeat badge\" src=\"https://codebeat.co/badges/8cb2671b-7640-4ac7-bb3e-823bb26a2db2\"></a></td>\n\t\t<td align=\"center\"><a href=\"https://app.codacy.com/gh/sepandhaghighi/mycoffee/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade\"><img src=\"https://app.codacy.com/project/badge/Grade/ac0a8041879042d4a7925272ea3f7ba5\"></a></td>\n\t</tr>\n</table>\n\n\n## Installation\t\t\n\n### Source Code\n- Download [Version 1.5](https://github.com/sepandhaghighi/mycoffee/archive/v1.5.zip) or [Latest Source](https://github.com/sepandhaghighi/mycoffee/archive/dev.zip)\n- `pip install .`\t\t\t\t\n\n### PyPI\n\n- Check [Python Packaging User Guide](https://packaging.python.org/installing/) \n- `pip install mycoffee==1.5`\t\t\t\t\t\t\n\n\n## Usage\n\n\u2139\ufe0f You can use `mycoffee` or `python -m mycoffee` to run this program\n\n### Version\n\n```console\n> mycoffee --version\n\n1.5\n```\n\n### Info\n\n```console\n> mycoffee --info\n\n __ __ ____ __ __\n| \\/ | _ _ / ___| ___ / _| / _| ___ ___\n| |\\/| || | | || | / _ \\ | |_ | |_ / _ \\ / _ \\\n| | | || |_| || |___ | (_) || _|| _|| __/| __/\n|_| |_| \\__, | \\____| \\___/ |_| |_| \\___| \\___|\n |___/\n\n__ __ _ ____\n\\ \\ / / _ / | | ___|\n \\ \\ / / (_)| | |___ \\\n \\ V / _ | | _ ___) |\n \\_/ (_)|_|(_)|____/\n\n\n\nMyCoffee is a command-line tool for coffee enthusiasts who love brewing with precision.\nIt helps you calculate the perfect coffee-to-water ratio for various brewing methods,\nensuring you brew your ideal cup every time-right from your terminal.\n\nRepo : https://github.com/sepandhaghighi/mycoffee\n```\n\n### Method\n\n```console\n> mycoffee --method=v60\n __ __ _ _ ___ _____ ____ ____ ____ ____\n( \\/ )( \\/ ) / __)( _ )( ___)( ___)( ___)( ___)\n ) ( \\ / ( (__ )(_)( )__) )__) )__) )__)\n(_/\\/\\_) (__) \\___)(_____)(__) (__) (____)(____)\n\n\n\nMethod: `v60`\n\nCups: 1\n\nCoffee: 15 g\n\nWater: 250 g\n\nRatio: 3/50\n\nGrind: 550 um (Medium-Fine)\n\nTemperature: 91 C\n\nMessage: V60 method\n```\n\n* [Methods List](https://github.com/sepandhaghighi/mycoffee/blob/main/METHODS.md)\n* `mycoffee --methods-list`\n\n### Customize\n\n\u2139\ufe0f You can run `mycoffee --coffee-units-list` to view the supported coffee units\n\n\u2139\ufe0f You can run `mycoffee --water-units-list` to view the supported water units\n\n```console\n> mycoffee --method=chemex --water=20 --cups=3 --coffee-ratio=2 --water-ratio=37 --coffee-unit=\"t oz\" --water-unit=\"fl oz\" --grind=750 --temperature=88\n\n __ __ _ _ ___ _____ ____ ____ ____ ____\n( \\/ )( \\/ ) / __)( _ )( ___)( ___)( ___)( ___)\n ) ( \\ / ( (__ )(_)( )__) )__) )__) )__)\n(_/\\/\\_) (__) \\___)(_____)(__) (__) (____)(____)\n\n\n\nMethod: `chemex`\n\nCups: 3\n\nCoffee: 3.084 t oz\n\nWater: 20 fl oz\n\nRatio: 2/37\n\nGrind: 750 um (Medium)\n\nTemperature: 88 C\n\nMessage: Chemex method\n```\n\n## Parameters\n\n<table>\n <thead>\n <tr>\n <th align=\"center\">Parameter</th>\n <th align=\"center\">Description</th>\n <th align=\"center\">Type</th>\n <th align=\"center\">Default</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n <td align=\"center\"><code>--method</code></td>\n <td align=\"center\">Specifies the coffee brewing method</td>\n <td align=\"center\">String</td>\n <td align=\"center\"><code>custom</code></td>\n </tr>\n <tr>\n <td align=\"center\"><code>--water</code></td>\n <td align=\"center\">Sets the amount of water in each cup</td>\n <td align=\"center\">Positive float</td>\n <td align=\"center\"><code>240</code></td>\n </tr>\n <tr>\n <td align=\"center\"><code>--cups</code></td>\n <td align=\"center\">Indicates the number of cups</td>\n <td align=\"center\">Positive integer</td>\n <td align=\"center\"><code>1</code></td>\n </tr>\n <tr>\n <td align=\"center\"><code>--grind</code></td>\n <td align=\"center\">Grind size (um)</td>\n <td align=\"center\">Positive integer</td>\n <td align=\"center\"><code>700</code></td>\n </tr>\n <tr>\n <td align=\"center\"><code>--temperature</code></td>\n <td align=\"center\">Brewing temperature</td>\n <td align=\"center\">Float</td>\n <td align=\"center\"><code>90</code></td>\n </tr>\n <tr>\n <td align=\"center\"><code>--coffee-ratio</code></td>\n <td align=\"center\">Coefficient for the coffee component in the ratio</td>\n <td align=\"center\">Positive float</td>\n <td align=\"center\"><code>1</code></td>\n </tr>\n <tr>\n <td align=\"center\"><code>--water-ratio</code></td>\n <td align=\"center\">Coefficient for the water component in the ratio</td>\n <td align=\"center\">Positive float</td>\n <td align=\"center\"><code>17</code></td>\n </tr>\n <tr>\n <td align=\"center\"><code>--message</code></td>\n <td align=\"center\">Extra information about the brewing method</td>\n <td align=\"center\">String</td>\n <td align=\"center\"><code>Custom brewing method</code></td>\n </tr>\n <tr>\n <td align=\"center\"><code>--digits</code></td>\n <td align=\"center\">Number of digits up to which the result is rounded</td>\n <td align=\"center\">Integer</td>\n <td align=\"center\"><code>3</code></td>\n </tr>\n <tr>\n <td align=\"center\"><code>--coffee-unit</code></td>\n <td align=\"center\">Coffee unit</td>\n <td align=\"center\">String</td>\n <td align=\"center\"><code>g</code></td>\n </tr>\n <tr>\n <td align=\"center\"><code>--water-unit</code></td>\n <td align=\"center\">Water unit</td>\n <td align=\"center\">String</td>\n <td align=\"center\"><code>g</code></td>\n </tr>\n <tr>\n <td align=\"center\"><code>--temperature-unit</code></td>\n <td align=\"center\">Temperature unit</td>\n <td align=\"center\">String</td>\n <td align=\"center\"><code>C</code></td>\n </tr>\n </tbody>\n</table>\n\n\n\n## Issues & Bug Reports\t\t\t\n\nJust fill an issue and describe it. We'll check it ASAP!\n\n- Please complete the issue template\n \t\t\t\n\n## References\n\n<blockquote>1- <a href=\"https://honestcoffeeguide.com/coffee-to-water-ratio-calculator/\">Coffee to water ratio calculator</a></blockquote>\n<blockquote>2- <a href=\"https://www.origincoffee.co.uk/blogs/journal/brewing-at-home-v60\">V60 Brew Guide</a></blockquote>\n<blockquote>3- <a href=\"https://unionroasted.com/blogs/brewing-guides/chemex-pour-over\">How to Brew Coffee with a Chemex</a></blockquote>\n<blockquote>4- <a href=\"https://www.illy.com/en-us/coffee/coffee-preparation/how-to-use-a-french-press\">Using French press for perfect coffee</a></blockquote>\n<blockquote>5- <a href=\"https://www.haymancoffee.com/blogs/coffee-blog/how-to-brew-the-perfect-cup-of-siphon-coffee\">How to Brew the Perfect Cup of Siphon Coffee</a></blockquote>\n<blockquote>6- <a href=\"https://home.lamarzoccousa.com/using-espresso-brew-ratios/\">Using Espresso Brew Ratios</a></blockquote>\n<blockquote>7- <a href=\"https://www.nicolebattefeld.com/post/best-recipes-2022\">My Best Coffee Recipes of 2022</a></blockquote>\n<blockquote>8- <a href=\"https://wonderstate.com/pages/auto-drip\">Auto Drip Brewing Guide</a></blockquote>\n<blockquote>9- <a href=\"https://counterculturecoffee.com/blogs/counter-culture-coffee/guide-to-cold-brew\">Guide To Cold Brew</a></blockquote>\n<blockquote>10- <a href=\"https://www.thespruceeats.com/cold-brew-concentrate-recipe-5197494\">Cold Brew Concentrate Recipe</a></blockquote>\n<blockquote>11- <a href=\"https://bakedbrewedbeautiful.com/how-to-make-coffee-in-moka-pot/\">How to Make Coffee in a Moka Pot</a></blockquote>\n<blockquote>12- <a href=\"https://www.drinktrade.com/blogs/education/how-to-make-turkish-coffee\">How to Make Turkish Coffee at Home</a></blockquote>\n<blockquote>13- <a href=\"https://www.horshamcoffeeroaster.co.uk/pages/how-to-cup-coffee\">How to Cup Coffee</a></blockquote>\n<blockquote>14- <a href=\"https://aeroprecipe.com/recipes/tetsu-kasuya-aeropress-recipe\">Tetsu Kasuya AeroPress Recipe</a></blockquote>\n<blockquote>15- <a href=\"https://aeroprecipe.com/recipes/all-about-the-intervals\">All about the intervals</a></blockquote>\n<blockquote>16- <a href=\"https://squaremileblog.com/brew-guide-clever-dripper/\">Clever Dripper; Square Mile Coffee</a></blockquote>\n<blockquote>17- <a href=\"https://www.seattlecoffeegear.com/pages/product-resource/aero-press-product-resources\">AeroPress Product User Manuals</a></blockquote>\n<blockquote>18- <a href=\"https://www.rapidtables.com/convert/weight/index.html\">RapidTables - Weight Converter</a></blockquote>\n<blockquote>19- <a href=\"https://honestcoffeeguide.com/whole-bean-to-ground-coffee-ratio/\">Whole bean to ground coffee calculator</a></blockquote>\n<blockquote>20- <a href=\"https://www.howmany.wiki/wv/\">Weight to Volume Converter for Recipes</a></blockquote>\n<blockquote>21- <a href=\"https://chamberlaincoffee.com/blogs/inspiration/how-much-coffee-per-cup-this-is-how-you-get-it-right\">How Much Coffee per Cup?</a></blockquote>\n<blockquote>22- <a href=\"https://www.calculator.net/weight-calculator.html\">Weight Calculator</a></blockquote>\n<blockquote>23- <a href=\"https://www.inchcalculator.com/convert/volume/\">Volume Conversion Calculator - Inch Calculator</a></blockquote>\n<blockquote>24- <a href=\"https://www.metric-conversions.org/\">Metric Conversion Charts and Calculators</a></blockquote>\n<blockquote>25- <a href=\"https://honestcoffeeguide.com/coffee-grind-size-chart\">Coffee grind size chart</a></blockquote>\n<blockquote>26- <a href=\"https://honestcoffeeguide.com/best-temperature-to-brew-coffee/\">The best temperature to brew coffee</a></blockquote>\n<blockquote>27- <a href=\"https://unionroasted.com/blogs/brewing-guides/syphon\">How to Brew Coffee with a Syphon</a></blockquote>\n<blockquote>28- <a href=\"https://counterculturecoffee.com/blogs/counter-culture-coffee/guide-to-home-coffee-makers\">Guide To Home Coffee Makers</a></blockquote>\n<blockquote>29- <a href=\"https://perfectdailygrind.com/2021/07/can-you-brew-coffee-with-warm-water\">Can you brew coffee with warm water?</a></blockquote>\n<blockquote>30- <a href=\"https://ravecoffee.co.uk/blogs/news/how-to-brew-coffee-using-an-ibrik-cezve-for-turkish-style-coffee\">How to Brew Coffee Using a Cezve</a></blockquote>\n<blockquote>31- <a href=\"https://www.diffordsguide.com/g/1113/coffee/cupping\">Coffee cupping</a></blockquote>\n\n## Show Your Support\n\t\t\t\t\t\t\t\t\n<h3>Star This Repo</h3>\t\t\t\t\t\n\nGive a \u2b50\ufe0f if this project helped you!\n\n<h3>Donate to Our Project</h3>\t\n\n<h4>Bitcoin</h4>\n1KtNLEEeUbTEK9PdN6Ya3ZAKXaqoKUuxCy\n<h4>Ethereum</h4>\n0xcD4Db18B6664A9662123D4307B074aE968535388\n<h4>Litecoin</h4>\nLdnz5gMcEeV8BAdsyf8FstWDC6uyYR6pgZ\n<h4>Doge</h4>\nDDUnKpFQbBqLpFVZ9DfuVysBdr249HxVDh\n<h4>Tron</h4>\nTCZxzPZLcJHr2qR3uPUB1tXB6L3FDSSAx7\n<h4>Ripple</h4>\nrN7ZuRG7HDGHR5nof8nu5LrsbmSB61V1qq\n<h4>Binance Coin</h4>\nbnb1zglwcf0ac3d0s2f6ck5kgwvcru4tlctt4p5qef\n<h4>Tether</h4>\n0xcD4Db18B6664A9662123D4307B074aE968535388\n<h4>Dash</h4>\nXd3Yn2qZJ7VE8nbKw2fS98aLxR5M6WUU3s\n<h4>Stellar</h4>\t\t\nGALPOLPISRHIYHLQER2TLJRGUSZH52RYDK6C3HIU4PSMNAV65Q36EGNL\n<h4>Zilliqa</h4>\nzil1knmz8zj88cf0exr2ry7nav9elehxfcgqu3c5e5\n<h4>Coffeete</h4>\n<a href=\"http://www.coffeete.ir/opensource\">\n<img src=\"http://www.coffeete.ir/images/buttons/lemonchiffon.png\" style=\"width:260px;\" />\n</a>\n\n\n# Changelog\nAll notable changes to this project will be documented in this file.\n\nThe format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)\nand this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).\n\n## [Unreleased]\n## [1.5] - 2025-02-26\n### Added\n- `--info` argument\n- `--ignore-warnings` argument\n- `--temperature-unit` argument\n- `--temperature-units-list` argument\n### Changed\n- Test system modified\n- `README.md` updated\n## [1.4] - 2025-02-15\n### Added\n- `--temperature` argument\n- Temperature upper limit\n- Temperature lower limit\n### Changed\n- `--info` argument renamed to `--message`\n- Warning messages updated\n- `README.md` updated\n- `METHODS.md` updated\n## [1.3] - 2025-01-31\n### Added\n- `get_grind_type` function\n- `validate_positive_int` function\n- `validate_positive_float` function\n### Changed\n- `README.md` updated\n- `check_ratio_limits` function bug fixed\n- String templates modified\n- Test system modified\n## [1.2] - 2025-01-13\n### Added\n- 2 new water units\n\t1. Troy Pounds (`t lb`)\n\t2. Pennyweight (`dwt`)\n- 2 new coffee units\n\t1. Troy Pounds (`t lb`)\n\t2. Pennyweight (`dwt`)\n- `--grind` argument\n- Grind upper limit\n- Grind lower limit\n- `check_grind_limits` function\n### Changed\n- `README.md` updated\n- `METHODS.md` updated\n## [1.1] - 2025-01-02\n### Added\n- 5 new water units\n\t1. Troy Ounce (`t oz`)\n\t2. Grain (`gr`)\n\t3. Carats (`ct`)\n\t4. Cubic Centimeters (`cc`)\n\t5. Centiliters (`cl`)\n- 3 new coffee units\n\t1. Troy Ounce (`t oz`)\n\t2. Grain (`gr`)\n\t3. Carats (`ct`)\n### Changed\n- `README.md` updated\n## [1.0] - 2024-12-17\n### Added\n- 3 new water units\n\t1. Pint (`pt`)\n\t2. Quart (`qt`)\n\t3. Fluid Ounce (`fl oz`)\n### Changed\n- `README.md` updated\n## [0.9] - 2024-12-06\n### Added\n- 4 new water units\n\t1. Tablespoon (`tbsp`)\n\t2. Teaspoon (`tsp`)\n\t3. Dessertspoon (`dsp`)\n\t4. Cup (`cup`)\n## [0.8] - 2024-11-29\n### Added\n- 1 new coffee unit\n\t1. Cup (`cup`)\n- 6 new water units\n\t1. Milliliter (`ml`)\n\t2. Liter (`l`)\n\t3. Ounce (`oz`)\n\t4. Pound (`lb`)\n\t5. Milligram (`mg`)\n\t6. Kilogram (`kg`)\n- `convert_water` function\n- `show_water_units_list` function\n- `--water-unit` argument\n### Changed\n- Test system modified\n- `README.md` updated\n## [0.7] - 2024-11-21\n### Added\n- 4 new coffee units\n\t1. Coffee beans (`cb`)\n\t2. Tablespoon (`tbsp`)\n\t3. Teaspoon (`tsp`)\n\t4. Dessertspoon (`dsp`)\n- `convert_coffee` function\n### Changed\n- GitHub actions are limited to the `dev` and `main` branches\n## [0.6] - 2024-10-18\n### Added\n- `show_coffee_units_list` function\n- `--coffee-unit` argument\n### Changed\n- Test system modified\n- Cups bug fixed\n- `calc_coffee` function updated\n- `README.md` updated\n- `Python 3.13` added to `test.yml`\n## [0.5] - 2024-10-08\n### Added\n- Ratio upper limit\n- Ratio lower limit\n- `check_ratio_limits` function\n### Changed\n- Test system modified\n- `print_message` function renamed to `print_result`\n## [0.4] - 2024-10-01\n### Added\n- 4 new methods\n\t1. AeroPress standard\n\t2. AeroPress concentrate\n\t3. AeroPress inverted\n\t4. Steep-and-release\n- `--digits` argument\n### Changed\n- `README.md` updated\n- Test system modified\n- `filter_params` function updated\n## [0.3] - 2024-09-24\n### Added\n- Logo\n- 4 new methods\n\t1. Ristretto\n\t2. Lungo\n\t3. Turkish\n\t4. Cupping\n## [0.2] - 2024-09-17\n### Added\n- 5 new methods\n\t1. Pour-over\n\t2. Auto drip\n\t3. Cold brew\n\t4. Cold brew concentrate\n\t5. Moka pot\n- `is_int` function\n- `filter_params` function\n### Changed\n- `README.md` updated\n- `--coffee-ratio` type changed from `int` to `float`\n- `--water-ratio` type changed from `int` to `float`\n- `coffee_calc` function renamed to `calc_coffee`\n- `print_message` function updated\n- Test system modified\n## [0.1] - 2024-09-02\n### Added\n- 6 new methods\n\t1. V60\n\t2. Espresso\n\t3. Chemex\n\t4. French-press\n\t5. Siphon\n\t6. Custom\n\n[Unreleased]: https://github.com/sepandhaghighi/mycoffee/compare/v1.5...dev\n[1.5]: https://github.com/sepandhaghighi/mycoffee/compare/v1.4...v1.5\n[1.4]: https://github.com/sepandhaghighi/mycoffee/compare/v1.3...v1.4\n[1.3]: https://github.com/sepandhaghighi/mycoffee/compare/v1.2...v1.3\n[1.2]: https://github.com/sepandhaghighi/mycoffee/compare/v1.1...v1.2\n[1.1]: https://github.com/sepandhaghighi/mycoffee/compare/v1.0...v1.1\n[1.0]: https://github.com/sepandhaghighi/mycoffee/compare/v0.9...v1.0\n[0.9]: https://github.com/sepandhaghighi/mycoffee/compare/v0.8...v0.9\n[0.8]: https://github.com/sepandhaghighi/mycoffee/compare/v0.7...v0.8\n[0.7]: https://github.com/sepandhaghighi/mycoffee/compare/v0.6...v0.7\n[0.6]: https://github.com/sepandhaghighi/mycoffee/compare/v0.5...v0.6\n[0.5]: https://github.com/sepandhaghighi/mycoffee/compare/v0.4...v0.5\n[0.4]: https://github.com/sepandhaghighi/mycoffee/compare/v0.3...v0.4\n[0.3]: https://github.com/sepandhaghighi/mycoffee/compare/v0.2...v0.3\n[0.2]: https://github.com/sepandhaghighi/mycoffee/compare/v0.1...v0.2\n[0.1]: https://github.com/sepandhaghighi/mycoffee/compare/c2d0bb4...v0.1\n\n\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Brew Perfect Coffee Right from Your Terminal",
"version": "1.5",
"project_urls": {
"Download": "https://github.com/sepandhaghighi/mycoffee/tarball/v1.5",
"Homepage": "https://github.com/sepandhaghighi/mycoffee",
"Source": "https://github.com/sepandhaghighi/mycoffee"
},
"split_keywords": [
"coffee",
"ratio",
"terminal",
"brew",
"cli"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "036889f0b31d8a5bcb0522648cb5f7877512b33d26bdd91b4cea6403316712d0",
"md5": "d0c391835981f1db3754fde74ed88027",
"sha256": "4277c471cacb8e34b29c73cbc14d33c82bbd531cd707d6153262a0dfaf96a985"
},
"downloads": -1,
"filename": "mycoffee-1.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d0c391835981f1db3754fde74ed88027",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 14378,
"upload_time": "2025-02-26T17:41:56",
"upload_time_iso_8601": "2025-02-26T17:41:56.211693Z",
"url": "https://files.pythonhosted.org/packages/03/68/89f0b31d8a5bcb0522648cb5f7877512b33d26bdd91b4cea6403316712d0/mycoffee-1.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "581398d8ebcbe2845a3625857593763f475377195a2d23b753106fd4e7650c5a",
"md5": "6f894fe39bfd88a02d8d18d4d340d72a",
"sha256": "a09760f193306ab7b9453e36297ed8b6c350f7fa3547ebecb1f4d39bbd98e505"
},
"downloads": -1,
"filename": "mycoffee-1.5.tar.gz",
"has_sig": false,
"md5_digest": "6f894fe39bfd88a02d8d18d4d340d72a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 21764,
"upload_time": "2025-02-26T17:41:54",
"upload_time_iso_8601": "2025-02-26T17:41:54.245246Z",
"url": "https://files.pythonhosted.org/packages/58/13/98d8ebcbe2845a3625857593763f475377195a2d23b753106fd4e7650c5a/mycoffee-1.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-02-26 17:41:54",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "sepandhaghighi",
"github_project": "mycoffee",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"requirements": [
{
"name": "art",
"specs": [
[
">=",
"5.3"
]
]
}
],
"lcname": "mycoffee"
}
JSON
