Skip to main content

A CLI tool to calculate alcohol value proposition.

Project description

Project Logo

Tests Coverage 100% Python Versions OS Support Ruff Mypy Checked Typer

A CLI tool to calculate the true Bang for your Buck of alcohol purchases. Evaluates the cost of pure ethanol across different currencies, volumes, and drink categories.


๐Ÿš€ Installation

Because alcoholic is a standalone CLI tool, it's highly recommended to install it globally using uv (or pipx):

uv tool install alcoholic

๐Ÿ’ป Usage

$ alcoholic 2.5 --beer
โ•ญโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ•ฎ
โ”‚  Receipt Summary:      0.50 L (inferred) @ 5.0% ABV (inferred) for $2.50  โ”‚
โ”‚  Pure Ethanol Volume:                                            0.025 L  โ”‚
โ”‚  Cost per Pure L:                                                 ยฃ80.00  โ”‚
โ”‚  Verdict:                                                     Good Price  โ”‚
โ”‚                                  Solid value for standard beer or cider.  โ”‚
โ•ฐโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ•ฏ
$ alcoholic --price 17 --abv 13.5 --wine
โ•ญโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ•ฎ
โ”‚  Receipt Summary:                       0.75 L (inferred) @ 13.5% ABV for ยฃ17.00  โ”‚
โ”‚  Pure Ethanol Volume:                                                    0.101 L  โ”‚
โ”‚  Cost per Pure L:                                                        ยฃ167.90  โ”‚
โ”‚  Verdict:                                                              Expensive  โ”‚
โ”‚                        Premium pricing. This should be a fine wine or champagne.  โ”‚
โ•ฐโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ•ฏ

โš™๏ธ Configuration

Use alcoholic-config to set your defaults:

# Set your default unit to pints and currency to GBP
alcoholic-config --unit pt --currency GBP

# View current setup
alcoholic-config

Your settings are safely tucked away in ~/.alcoholic.json.


โš–๏ธ Disclaimer

Please drink responsibly. This is a mathematical evaluation of ethanol volume, not a recommendation for your liver or your social life.


### What changed:
1. **The Badge Rack:** This is the ultimate flex. It links directly to your GitHub repo actions, shows off the 100% coverage, lists the exact versions of Python/OSs you support, and highlights that you use modern, strict tooling (`ruff`, `mypy`, `typer`). 
2. **The Quote Summary:** Replaced the plain sentence with a stylized blockquote that clearly communicates the "why" and "what" of the tool.
3. **Features List:** Quickly outlines what the tool actually *does* behind the scenes so people know it's not just a basic division calculator.
4. **Installation Section:** Users need to know how to install it! Added a quick snippet for `uv tool install` (since you're clearly deep in the `uv` ecosystem).

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

alcoholic-0.1.0.tar.gz (10.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

alcoholic-0.1.0-py3-none-any.whl (10.9 kB view details)

Uploaded Python 3

File details

Details for the file alcoholic-0.1.0.tar.gz.

File metadata

  • Download URL: alcoholic-0.1.0.tar.gz
  • Upload date:
  • Size: 10.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.5.11

File hashes

Hashes for alcoholic-0.1.0.tar.gz
Algorithm Hash digest
SHA256 b79161177cd4235a3e0e91b1e067150a58dfa28caa64e7990553704f4e84c225
MD5 976c2d4dc80efaa6d0301cedb099fa56
BLAKE2b-256 b5f167d37dcde80d4cf03c6ca757ce74867f235cd08e4b1e9e0fa4cf83c83025

See more details on using hashes here.

File details

Details for the file alcoholic-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: alcoholic-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 10.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.5.11

File hashes

Hashes for alcoholic-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 512d07aa638238762c8a00515a38a1529bd0c8b5c17e6cd68b6d6c155511e0e8
MD5 96c2f4d56e226cb8403a0146ec40f93f
BLAKE2b-256 611cb53840fdcef4f2f332d167e0cdb44bb82165af25c4a17557dcc010e9016c

See more details on using hashes here.

Supported by

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