Skip to content

tynardone/brewcli

Repository files navigation

brewcli

A command-line interface (CLI) for exploring breweries via the Open Brewery DB API.

Code Style: Ruff Type Checked: Mypy Python Versions License Downloads

brewcli is a Python-based CLI tool designed to interact with the Open Brewery DB API. With brewcli, you can fetch random breweries, search breweries by city, state, or type, and more—all from the command line.

Features

  • Fetch a list of random breweries.
  • Search breweries by city, state, or brewery type.
  • Retrieve detailed information about a specific brewery.
  • Output data in a user-friendly format.

Installation

Install brewcli using pip:

pip install brewcli

Usage example

Here are some examples of how to use brewcli:

Get a Random Brewery

brewcli random

Search Breweries by City

brewcli search --city "Cincinnati"

Search Breweries by State and Type

brewcli search --state "California" --type "micro"

For more examples and usage instructions, please refer to the documentation.

Development setup

To set up a development environment for brewcli, follow these steps:

Clone the repository:

git clone https://github.com/yourname/brewcli.git
cd brewcli

Set up a virtual environment:

python -m venv venv
source venv/bin/activate  # On Windows, use `venv\Scripts\activate`

Install dependencies:

pip install -r requirements.txt

Run tests:

pytest

Release History

  • 0.0.1
    • Work in progress

Meta

Tyler Nardone – tynardone@gmail.com - LinkedIn

Distributed under the MIT license. See LICENSE for more information.

https://github.com/tynardone/brewcli

About

Command line tool for retrieving information on breweries from Open Brewery DB.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages