brewcli 0.1.0__tar.gz

brewcli-0.1.0/.claude/settings.local.json

@@ -0,0 +1,8 @@
+{
+  "permissions": {
+    "allow": [
+      "Bash(.venv/bin/pip install *)",
+      "Bash(.venv/bin/pytest tests/ -v)"
+    ]
+  }
+}

brewcli-0.1.0/.dockerignore

@@ -0,0 +1,27 @@
+**/__pycache__
+**/.venv
+**/.classpath
+**/.dockerignore
+**/.env
+**/.git
+**/.gitignore
+**/.project
+**/.settings
+**/.toolstarget
+**/.vs
+**/.vscode
+**/*.*proj.user
+**/*.dbmdl
+**/*.jfm
+**/bin
+**/charts
+**/docker-compose*
+**/compose*
+**/Dockerfile*
+**/node_modules
+**/npm-debug.log
+**/obj
+**/secrets.dev.yaml
+**/values.dev.yaml
+LICENSE
+README.md

brewcli-0.1.0/.gitignore

@@ -0,0 +1,174 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc

brewcli-0.1.0/.pre-commit-config.yaml

@@ -0,0 +1,24 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v2.3.0
+    hooks:
+      - id: check-yaml
+      - id: end-of-file-fixer
+      - id: check-added-large-files
+      - id: trailing-whitespace
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v1.8.0
+    hooks:
+      - id: mypy
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    # Ruff version.
+    rev: v0.7.2
+    hooks:
+      # Run the linter.
+      - id: ruff
+        name: ruff-sort
+        args: ["check", "--select", "I", "--fix"]
+      - id: ruff
+        args: [--fix]
+      # Run the formatter (similar to black)
+      - id: ruff-format

brewcli-0.1.0/.python-version

@@ -0,0 +1 @@
+3.12

brewcli-0.1.0/.vscode/launch.json

@@ -0,0 +1,19 @@
+{
+    "configurations": [
+        {
+            "name": "Containers: Python - General",
+            "type": "docker",
+            "request": "launch",
+            "preLaunchTask": "docker-run: debug",
+            "python": {
+                "pathMappings": [
+                    {
+                        "localRoot": "${workspaceFolder}",
+                        "remoteRoot": "/app"
+                    }
+                ],
+                "projectType": "general"
+            }
+        }
+    ]
+}

brewcli-0.1.0/.vscode/tasks.json

@@ -0,0 +1,26 @@
+{
+	"version": "2.0.0",
+	"tasks": [
+		{
+			"type": "docker-build",
+			"label": "docker-build",
+			"platform": "python",
+			"dockerBuild": {
+				"tag": "brewcli:latest",
+				"dockerfile": "${workspaceFolder}/Dockerfile",
+				"context": "${workspaceFolder}",
+				"pull": true
+			}
+		},
+		{
+			"type": "docker-run",
+			"label": "docker-run: debug",
+			"dependsOn": [
+				"docker-build"
+			],
+			"python": {
+				"file": "src/brewcli/__main__.py"
+			}
+		}
+	]
+}

brewcli-0.1.0/Dockerfile

@@ -0,0 +1,34 @@
+# Use the official uv image with Python preinstalled
+FROM ghcr.io/astral-sh/uv:python3.12-bookworm-slim
+
+# Keeps Python from generating .pyc files in the container
+ENV PYTHONDONTWRITEBYTECODE=1
+
+# Turns off buffering for easier container logging
+ENV PYTHONUNBUFFERED=1
+
+# Compile bytecode for faster startup and copy (not link) packages into the venv
+ENV UV_COMPILE_BYTECODE=1
+ENV UV_LINK_MODE=copy
+
+WORKDIR /app
+
+# Install dependencies first (cached layer) using the lockfile, without the project itself
+COPY pyproject.toml uv.lock ./
+RUN --mount=type=cache,target=/root/.cache/uv \
+    uv sync --frozen --no-install-project --no-dev
+
+# Copy the rest of the project and install it
+COPY . /app
+RUN --mount=type=cache,target=/root/.cache/uv \
+    uv sync --frozen --no-dev
+
+# Put the project's virtualenv on PATH
+ENV PATH="/app/.venv/bin:$PATH"
+
+# Creates a non-root user with an explicit UID and gives it access to /app
+RUN adduser -u 5678 --disabled-password --gecos "" appuser && chown -R appuser /app
+USER appuser
+
+# Run the installed console script
+CMD ["brewcli"]

brewcli-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+# MIT License
+
+Copyright (c) 2025 Tyler Nardone
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

brewcli-0.1.0/PKG-INFO

@@ -0,0 +1,132 @@
+Metadata-Version: 2.4
+Name: brewcli
+Version: 0.1.0
+Summary: A command-line interface for exploring breweries via the Open Brewery DB API.
+Project-URL: Homepage, https://github.com/tynardone/brewcli
+Project-URL: Repository, https://github.com/tynardone/brewcli
+Author-email: Tyler Nardone <tynardone@gmail.com>
+License-Expression: MIT
+License-File: LICENSE
+Keywords: beer,brewery,cli,openbrewerydb
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: End Users/Desktop
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Utilities
+Requires-Python: >=3.12
+Requires-Dist: click>=8.1.8
+Requires-Dist: httpx>=0.28.1
+Description-Content-Type: text/markdown
+
+# brewcli
+
+> A command-line interface (CLI) for exploring breweries via the [Open Brewery DB API](https://www.openbrewerydb.org/).
+
+![Code Style: Ruff][ruff-style]
+![Type Checked: Mypy][mypy-check]
+![Python Versions][python-versions]
+![License][license]
+![Downloads][downloads]
+
+`brewcli` is a Python-based CLI tool designed to interact with the [Open Brewery DB API](https://www.openbrewerydb.org/). 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, country, name, postal code, state, type, or distance from a coordinate.
+- Retrieve detailed information about a specific brewery by its ID.
+- Output data in a user-friendly format.
+
+## Installation
+
+Install `brewcli` using pip:
+
+```sh
+pip install brewcli
+```
+
+## Usage example
+
+Here are some examples of how to use brewcli:
+
+Get a number of random breweries (the count is required):
+
+```sh
+brewcli random 5
+```
+
+Look up a specific brewery by its ID:
+
+```sh
+brewcli by-id b54b16e1-ac3b-4bff-a11f-f7ae9ddc27e0
+```
+
+Search breweries by city:
+
+```sh
+brewcli search --by-city "Cincinnati"
+```
+
+Search breweries by state and type:
+
+```sh
+brewcli search --by-state "California" --by-type "micro"
+```
+
+Available `search` filters: `--by-city`, `--by-country`, `--by-dist` (coordinates as
+`'lat,lon'`), `--by-name`, `--by-postal`, `--by-state`, and `--by-type` (one of:
+`micro`, `nano`, `regional`, `brewpub`, `planning`, `contract`, `proprietor`, `closed`).
+
+Run `brewcli --help` or `brewcli <command> --help` for full usage details.
+
+## Development setup
+
+This project uses [uv](https://docs.astral.sh/uv/) for dependency management and is
+pinned to Python 3.12 (see `.python-version`).
+
+Clone the repository:
+
+```sh
+git clone https://github.com/tynardone/brewcli.git
+cd brewcli
+```
+
+Create the virtual environment and install all dependencies (runtime + dev) from the
+lockfile:
+
+```sh
+uv sync
+```
+
+Run the CLI:
+
+```sh
+uv run brewcli --help
+```
+
+Run tests:
+
+```sh
+uv run pytest
+```
+
+## Release History
+
+- 0.1.0
+  - Work in progress
+
+## Meta
+
+Tyler Nardone – <tynardone@gmail.com> - [LinkedIn](https://www.linkedin.com/in/tynardone/)
+
+Distributed under the MIT license. See ``LICENSE`` for more information.
+
+[https://github.com/tynardone/brewcli](https://github.com/tynardone/brewcli)
+
+<!-- Markdown link & img dfn's -->
+[python-versions]: https://img.shields.io/pypi/pyversions/brewcli
+[license]: https://img.shields.io/github/license/tynardone/brewcli
+[downloads]: https://img.shields.io/pypi/dm/brewcli
+[ruff-style]:https://img.shields.io/badge/code%20style-ruff-000000?style=flat&logo=python
+[mypy-check]:https://img.shields.io/badge/type%20checked-mypy-blue?style=flat&logo=python

brewcli-0.1.0/README.md

@@ -0,0 +1,111 @@
+# brewcli
+
+> A command-line interface (CLI) for exploring breweries via the [Open Brewery DB API](https://www.openbrewerydb.org/).
+
+![Code Style: Ruff][ruff-style]
+![Type Checked: Mypy][mypy-check]
+![Python Versions][python-versions]
+![License][license]
+![Downloads][downloads]
+
+`brewcli` is a Python-based CLI tool designed to interact with the [Open Brewery DB API](https://www.openbrewerydb.org/). 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, country, name, postal code, state, type, or distance from a coordinate.
+- Retrieve detailed information about a specific brewery by its ID.
+- Output data in a user-friendly format.
+
+## Installation
+
+Install `brewcli` using pip:
+
+```sh
+pip install brewcli
+```
+
+## Usage example
+
+Here are some examples of how to use brewcli:
+
+Get a number of random breweries (the count is required):
+
+```sh
+brewcli random 5
+```
+
+Look up a specific brewery by its ID:
+
+```sh
+brewcli by-id b54b16e1-ac3b-4bff-a11f-f7ae9ddc27e0
+```
+
+Search breweries by city:
+
+```sh
+brewcli search --by-city "Cincinnati"
+```
+
+Search breweries by state and type:
+
+```sh
+brewcli search --by-state "California" --by-type "micro"
+```
+
+Available `search` filters: `--by-city`, `--by-country`, `--by-dist` (coordinates as
+`'lat,lon'`), `--by-name`, `--by-postal`, `--by-state`, and `--by-type` (one of:
+`micro`, `nano`, `regional`, `brewpub`, `planning`, `contract`, `proprietor`, `closed`).
+
+Run `brewcli --help` or `brewcli <command> --help` for full usage details.
+
+## Development setup
+
+This project uses [uv](https://docs.astral.sh/uv/) for dependency management and is
+pinned to Python 3.12 (see `.python-version`).
+
+Clone the repository:
+
+```sh
+git clone https://github.com/tynardone/brewcli.git
+cd brewcli
+```
+
+Create the virtual environment and install all dependencies (runtime + dev) from the
+lockfile:
+
+```sh
+uv sync
+```
+
+Run the CLI:
+
+```sh
+uv run brewcli --help
+```
+
+Run tests:
+
+```sh
+uv run pytest
+```
+
+## Release History
+
+- 0.1.0
+  - Work in progress
+
+## Meta
+
+Tyler Nardone – <tynardone@gmail.com> - [LinkedIn](https://www.linkedin.com/in/tynardone/)
+
+Distributed under the MIT license. See ``LICENSE`` for more information.
+
+[https://github.com/tynardone/brewcli](https://github.com/tynardone/brewcli)
+
+<!-- Markdown link & img dfn's -->
+[python-versions]: https://img.shields.io/pypi/pyversions/brewcli
+[license]: https://img.shields.io/github/license/tynardone/brewcli
+[downloads]: https://img.shields.io/pypi/dm/brewcli
+[ruff-style]:https://img.shields.io/badge/code%20style-ruff-000000?style=flat&logo=python
+[mypy-check]:https://img.shields.io/badge/type%20checked-mypy-blue?style=flat&logo=python

brewcli-0.1.0/pyproject.toml

@@ -0,0 +1,74 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/brewcli"]
+
+[project]
+name = "brewcli"
+version = "0.1.0"
+description = "A command-line interface for exploring breweries via the Open Brewery DB API."
+readme = "README.md"
+authors = [{ name = "Tyler Nardone", email = "tynardone@gmail.com" }]
+license = "MIT"
+license-files = ["LICENSE"]
+requires-python = ">=3.12"
+keywords = ["brewery", "cli", "openbrewerydb", "beer"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Environment :: Console",
+    "Intended Audience :: End Users/Desktop",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.12",
+    "Topic :: Utilities",
+]
+dependencies = [
+    "click>=8.1.8",
+    "httpx>=0.28.1",
+]
+
+[project.urls]
+Homepage = "https://github.com/tynardone/brewcli"
+Repository = "https://github.com/tynardone/brewcli"
+
+[dependency-groups]
+dev = [
+    "black>=24.10.0",
+    "coverage>=7.6.10",
+    "isort>=5.13.2",
+    "mypy>=1.14.1",
+    "pre-commit>=4.0.1",
+    "pylint>=3.3.3",
+    "pytest>=8.3.4",
+    "pytest-cov>=6.0.0",
+    "pytest-httpx>=0.35.0",
+    "pytest-mock>=3.14.0",
+    "ruff>=0.7.2",
+]
+
+[project.scripts]
+brewcli = "brewcli.cli:cli"
+
+
+[tool.ruff.lint]
+select = [
+    # pycodestyle
+    "E",
+    "W",
+    # Pyflakes
+    "F",
+    # pyupgrade
+    "UP",
+    # flake8-bugbear
+    "B",
+    # flake8-simplify
+    "SIM",
+    # isort
+    "I",
+    "N",   # pep8 naming
+    "PL",  # pylint
+    "RUF", # ruff specific
+    "PD",  # pandas-vet
+]
+ignore = ["PLR2004"]

brewcli-0.1.0/src/brewcli/__main__.py

@@ -0,0 +1,4 @@
+from .cli import cli
+
+if __name__ == "__main__":
+    cli()