pymbrewclient 1.0.3__py3-none-any.whl

pymbrewclient/__init__.py

@@ -0,0 +1,36 @@
+# “Commons Clause” License Condition v1.0
+#
+# The Software is provided to you by the Licensor under the License, as defined below, subject to the following condition.
+#
+# Without limiting other conditions in the License, the grant of rights under the License will not include, and the License does not grant to you, the right to Sell the Software.
+#
+# For purposes of the foregoing, “Sell” means practicing any or all of the rights granted to you under the License to provide to third parties, for a fee or other consideration (including without limitation fees for hosting or consulting/ support services related to the Software), a product or service whose value derives, entirely or substantially, from the functionality of the Software. Any license notice or attribution required by the License must also include this Commons Clause License Condition notice.
+#
+# Software: pymbrewclient
+# License: MIT License
+# Licensor: Stuart Pearson
+#
+#
+# MIT License
+#
+# Copyright (c) 2024 Stuart Pearson
+#
+# 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.
+#
+# Disclaimer: This software is an independent project and is not affiliated with, endorsed by, or associated with MiniBrew. MiniBrew's trademarks, logos, API, and other intellectual property are owned by MiniBrew and are not included in this software. Users are responsible for complying with MiniBrew's terms of service when using this software.

pymbrewclient/cli.py

@@ -0,0 +1,274 @@
+# “Commons Clause” License Condition v1.0
+#
+# The Software is provided to you by the Licensor under the License, as defined below, subject to the following condition.
+#
+# Without limiting other conditions in the License, the grant of rights under the License will not include, and the License does not grant to you, the right to Sell the Software.
+#
+# For purposes of the foregoing, “Sell” means practicing any or all of the rights granted to you under the License to provide to third parties, for a fee or other consideration (including without limitation fees for hosting or consulting/ support services related to the Software), a product or service whose value derives, entirely or substantially, from the functionality of the Software. Any license notice or attribution required by the License must also include this Commons Clause License Condition notice.
+#
+# Software: pymbrewclient
+# License: MIT License
+# Licensor: Stuart Pearson
+#
+#
+# MIT License
+#
+# Copyright (c) 2024 Stuart Pearson
+#
+# 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.
+#
+# Disclaimer: This software is an independent project and is not affiliated with, endorsed by, or associated with MiniBrew. MiniBrew's trademarks, logos, API, and other intellectual property are owned by MiniBrew and are not included in this software. Users are responsible for complying with MiniBrew's terms of service when using this software.import typer
+import typer
+from pymbrewclient.rest.client import RestApiClient
+from rich import print as rich_print
+from rich.pretty import Pretty
+from loguru import logger
+import json
+from pydantic import BaseModel
+from typing import Annotated
+import sys
+
+app = typer.Typer(help="CLI for reading information from the Minibrew Pro Portal.", no_args_is_help=True)
+
+base_url = "https://api.minibrew.io"
+
+
+def initialize_client(base_url: str, username: str, password: str) -> RestApiClient:
+    """
+    Initialize the RestApiClient with the provided credentials.
+    """
+    return RestApiClient(base_url=base_url, username=username, password=password)
+
+
+def print_output(data: BaseModel | dict | list, format: str) -> None:
+    """Print output in the specified format."""
+    if isinstance(data, BaseModel):
+        data = data.dict()
+
+    if format == "json":
+        typer.echo(json.dumps(data, indent=4))
+    else:
+        rich_print(Pretty(data))
+
+
+def setup_logging(level: str) -> None:
+    """Configure loguru with the specified log level."""
+    logger.remove()  # Remove any default handlers
+    logger.add(sink=sys.stderr, level=level.upper())  # Add a new handler with the specified level
+
+
+@app.callback()
+def configure(
+    logging_level: Annotated[
+        str,
+        typer.Option(
+            "--logging-level",
+            help="Set the logging level (DEBUG, INFO, WARNING, ERROR, CRITICAL)",
+            case_sensitive=False,
+        ),
+    ] = "INFO",
+) -> None:
+    """
+    CLI for reading information from the MiniBrew Pro Portal.
+    """
+    setup_logging(logging_level)
+
+
+@app.command()
+def get_token(
+    username: str = typer.Option(..., "--username", help="The username for authentication."),
+    password: str = typer.Option(..., "--password", help="The password for authentication."),
+    base_url: str = typer.Option(base_url, "--base-url", help="The base URL for the API."),
+) -> None:
+    """
+    Fetch and display the token.
+    """
+    try:
+        logger.info("Fetching token...")
+        client = initialize_client(base_url, username, password)
+        token_response = client._get_token()
+        print_output(token_response, "pretty")
+    except Exception as e:
+        logger.error(f"Error fetching token: {e}")
+        typer.echo(f"Error fetching token: {e}")
+        raise typer.Exit(code=1)
+
+
+@app.command()
+def get_brewery_overview(
+    username: str = typer.Option(..., "--username", help="The username for authentication."),
+    password: str = typer.Option(..., "--password", help="The password for authentication."),
+    base_url: str = typer.Option(base_url, "--base-url", help="The base URL for the API."),
+) -> None:
+    """
+    Fetch and display the brewery overview.
+    """
+    try:
+        logger.info("Fetching brewery overview...")
+        client = initialize_client(base_url, username, password)
+        overview = client.get_brewery_overview()
+        print_output(overview, "pretty")
+    except Exception as e:
+        logger.error(f"Error fetching brewery overview: {e}")
+        typer.echo(f"Error fetching brewery overview: {e}")
+        raise typer.Exit(code=1)
+
+
+@app.command()
+def get_session_info(
+    username: str = typer.Option(..., "--username", help="The username for authentication."),
+    password: str = typer.Option(..., "--password", help="The password for authentication."),
+    base_url: str = typer.Option(base_url, "--base-url", help="The base URL for the API."),
+    sessionid: int = typer.Option(
+        ..., "--sessionid", help="The session ID to fetch information for.", flag_value="https://api.minibrew.io"
+    ),
+) -> None:
+    """
+    Fetch and display session information.
+    """
+    try:
+        logger.info(f"Fetching session info for session ID: {sessionid}...")
+        client = initialize_client(base_url, username, password)
+        session = client.get_session_info(sessionid)
+        print_output(session, "pretty")
+    except Exception as e:
+        logger.error(f"Error fetching session info: {e}")
+        typer.echo(f"Error fetching session info: {e}")
+        raise typer.Exit(code=1)
+
+
+@app.command()
+def get_fermenting(
+    username: str = typer.Option(..., "--username", help="The username for authentication."),
+    password: str = typer.Option(..., "--password", help="The password for authentication."),
+    base_url: str = typer.Option(base_url, "--base-url", help="The base URL for the API."),
+) -> None:
+    """
+    Fetch and display fermenting devices.
+    """
+    try:
+        logger.info("Fetching fermenting devices...")
+        client = initialize_client(base_url, username, password)
+        overview = client.get_brewery_overview()
+        print_output(overview.fermenting, "pretty")
+    except Exception as e:
+        logger.error(f"Error fetching fermenting devices: {e}")
+        typer.echo(f"Error fetching fermenting devices: {e}")
+        raise typer.Exit(code=1)
+
+
+@app.command()
+def get_serving(
+    username: str = typer.Option(..., "--username", help="The username for authentication."),
+    password: str = typer.Option(..., "--password", help="The password for authentication."),
+    base_url: str = typer.Option(base_url, "--base-url", help="The base URL for the API."),
+) -> None:
+    """
+    Fetch and display serving devices.
+    """
+    try:
+        logger.info("Fetching serving devices...")
+        client = initialize_client(base_url, username, password)
+        overview = client.get_brewery_overview()
+        print_output(overview.serving, "pretty")
+    except Exception as e:
+        logger.error(f"Error fetching serving devices: {e}")
+        typer.echo(f"Error fetching serving devices: {e}")
+        raise typer.Exit(code=1)
+
+
+@app.command()
+def get_brew_clean_idle(
+    username: str = typer.Option(..., "--username", help="The username for authentication."),
+    password: str = typer.Option(..., "--password", help="The password for authentication."),
+    base_url: str = typer.Option(base_url, "--base-url", help="The base URL for the API."),
+) -> None:
+    """
+    Fetch and display brew clean idle devices.
+    """
+    try:
+        client = initialize_client(base_url, username, password)
+        overview = client.get_brewery_overview()
+        print_output(overview.brew_clean_idle, "pretty")
+    except Exception as e:
+        logger.error(f"Error fetching brew clean idle devices: {e}")
+        typer.echo(f"Error fetching brew clean idle devices: {e}")
+        raise typer.Exit(code=1)
+
+
+@app.command()
+def get_brew_acid_clean_idle(
+    username: str = typer.Option(..., "--username", help="The username for authentication."),
+    password: str = typer.Option(..., "--password", help="The password for authentication."),
+    base_url: str = typer.Option(base_url, "--base-url", help="The base URL for the API."),
+) -> None:
+    """
+    Fetch and display brew acid clean idle devices.
+    """
+    try:
+        client = initialize_client(base_url, username, password)
+        overview = client.get_brewery_overview()
+        print_output(overview.brew_acid_clean_idle, "pretty")
+    except Exception as e:
+        logger.error(f"Error fetching brew acid clean idle devices: {e}")
+        typer.echo(f"Error fetching brew acid clean idle devices: {e}")
+        raise typer.Exit(code=1)
+
+
+@app.command()
+def get_minibrew_devices(
+    username: str = typer.Option(..., "--username", help="The username for authentication."),
+    password: str = typer.Option(..., "--password", help="The password for authentication."),
+    base_url: str = typer.Option(base_url, "--base-url", help="The base URL for the API."),
+) -> None:
+    """
+    Fetch and display all devices.
+    """
+    try:
+        logger.info("Fetching all devices...")
+        client = initialize_client(base_url, username, password)
+        overview = client.get_brewery_overview()
+        all_devices = overview.brew_clean_idle + overview.fermenting + overview.serving + overview.brew_acid_clean_idle
+
+        # Only select unique devices and get only uuid, serial_number, title, and software version
+        unique_devices = list(
+            {
+                device["uuid"]: device for device in all_devices if "uuid" in device and device["uuid"] is not None
+            }.values()
+        )
+
+        selected_data = [
+            {
+                "Serial Number": device["serial_number"],
+                "Nickname": device["title"],
+                "Version": device["software_version"],
+                "Is online": device["online"],
+                "Stage": device["stage"],
+            }
+            for device in unique_devices
+        ]
+        print_output(selected_data, "pretty")
+    except Exception as e:
+        logger.error(f"Error fetching all devices: {e}")
+        typer.echo(f"Error fetching all devices: {e}")
+        raise typer.Exit(code=1)
+
+
+if __name__ == "__main__":
+    app()

pymbrewclient/pymbrewclient.py

@@ -0,0 +1,79 @@
+# “Commons Clause” License Condition v1.0
+#
+# The Software is provided to you by the Licensor under the License, as defined below, subject to the following condition.
+#
+# Without limiting other conditions in the License, the grant of rights under the License will not include, and the License does not grant to you, the right to Sell the Software.
+#
+# For purposes of the foregoing, “Sell” means practicing any or all of the rights granted to you under the License to provide to third parties, for a fee or other consideration (including without limitation fees for hosting or consulting/ support services related to the Software), a product or service whose value derives, entirely or substantially, from the functionality of the Software. Any license notice or attribution required by the License must also include this Commons Clause License Condition notice.
+#
+# Software: pymbrewclient
+# License: MIT License
+# Licensor: Stuart Pearson
+#
+#
+# MIT License
+#
+# Copyright (c) 2024 Stuart Pearson
+#
+# 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.
+#
+# Disclaimer: This software is an independent project and is not affiliated with, endorsed by, or associated with MiniBrew. MiniBrew's trademarks, logos, API, and other intellectual property are owned by MiniBrew and are not included in this software. Users are responsible for complying with MiniBrew's terms of service when using this software.from pymbrewclient.rest.client import RestApiClient
+from pymbrewclient.rest.client import RestApiClient
+from pymbrewclient.rest.models import TokenResponse, BreweryOverview, Session
+
+
+class pymbrewclient:
+    """
+    A client for interacting with the Minibrew Pro Portal API.
+    """
+
+    def __init__(self, username: str, password: str, base_url: str = "https://api.minibrew.io") -> None:
+        """
+        Initialize the client with the base URL and user credentials.
+
+        :param base_url: The base URL for the API.
+        :param username: The username for authentication.
+        :param password: The password for authentication.
+        """
+        self.client = RestApiClient(base_url=base_url, username=username, password=password)
+
+    def get_token(self) -> TokenResponse:
+        """
+        Fetch and return the authentication token.
+
+        :return: A TokenResponse object containing the token and expiry time.
+        """
+        return self.client._get_token()
+
+    def get_brewery_overview(self) -> BreweryOverview:
+        """
+        Fetch and return the brewery overview.
+
+        :return: A BreweryOverview object containing the overview data.
+        """
+        return self.client.get_brewery_overview()
+
+    def get_session_info(self, sessionid: int) -> Session:
+        """
+        Fetch and return session information for a given session ID.
+
+        :param sessionid: The session ID to fetch information for.
+        :return: A Session object containing the session data.
+        """
+        return self.client.get_session_info(sessionid)

pymbrewclient/rest/__init__.py

@@ -0,0 +1,36 @@
+# “Commons Clause” License Condition v1.0
+#
+# The Software is provided to you by the Licensor under the License, as defined below, subject to the following condition.
+#
+# Without limiting other conditions in the License, the grant of rights under the License will not include, and the License does not grant to you, the right to Sell the Software.
+#
+# For purposes of the foregoing, “Sell” means practicing any or all of the rights granted to you under the License to provide to third parties, for a fee or other consideration (including without limitation fees for hosting or consulting/ support services related to the Software), a product or service whose value derives, entirely or substantially, from the functionality of the Software. Any license notice or attribution required by the License must also include this Commons Clause License Condition notice.
+#
+# Software: pymbrewclient
+# License: MIT License
+# Licensor: Stuart Pearson
+#
+#
+# MIT License
+#
+# Copyright (c) 2024 Stuart Pearson
+#
+# 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.
+#
+# Disclaimer: This software is an independent project and is not affiliated with, endorsed by, or associated with MiniBrew. MiniBrew's trademarks, logos, API, and other intellectual property are owned by MiniBrew and are not included in this software. Users are responsible for complying with MiniBrew's terms of service when using this software.

pymbrewclient/rest/client.py

@@ -0,0 +1,163 @@
+# “Commons Clause” License Condition v1.0
+#
+# The Software is provided to you by the Licensor under the License, as defined below, subject to the following condition.
+#
+# Without limiting other conditions in the License, the grant of rights under the License will not include, and the License does not grant to you, the right to Sell the Software.
+#
+# For purposes of the foregoing, “Sell” means practicing any or all of the rights granted to you under the License to provide to third parties, for a fee or other consideration (including without limitation fees for hosting or consulting/ support services related to the Software), a product or service whose value derives, entirely or substantially, from the functionality of the Software. Any license notice or attribution required by the License must also include this Commons Clause License Condition notice.
+#
+# Software: pymbrewclient
+# License: MIT License
+# Licensor: Stuart Pearson
+#
+#
+# MIT License
+#
+# Copyright (c) 2024 Stuart Pearson
+#
+# 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.
+#
+# Disclaimer: This software is an independent project and is not affiliated with, endorsed by, or associated with MiniBrew. MiniBrew's trademarks, logos, API, and other intellectual property are owned by MiniBrew and are not included in this software. Users are responsible for complying with MiniBrew's terms of service when using this software.import requests
+
+from typing import Any
+import requests
+import time
+from .models import TokenResponse, ApiResponse, BreweryOverview, Session
+from loguru import logger
+
+
+class RestApiClient:
+    def __init__(self, username: str, password: str, base_url: str, headers: dict[str, str] | None = None) -> None:
+        """
+        Initialize the REST API client for mbrewclient.
+
+        :param base_url: The base URL for the API.
+        :param username: The username for the Minibrew Pro Portal.
+        :param password: The password for the Minibrew Pro Portal.
+        """
+        self.base_url = base_url.rstrip("/")
+        self.username = username
+        self.password = password
+        self.headers = {"Client": "Breweryportal", "Content-Type": "application/json"}
+        self.token = None
+        self.token_expiry = 0
+
+    def _get_token(self) -> TokenResponse:
+        """
+        Obtain a new token using the username and password.
+
+        :return: A TokenResponse object containing the token and expiry time.
+        """
+        logger.debug("Fetching new token...")
+        url = "v2/token"
+        token_headers = self.headers.copy()
+        token_headers["Authorization"] = "TOKEN 4c433da015985d17669c604a5a4e2c906083e815"
+
+        response = self.post(
+            endpoint=url,
+            json={"email": self.username, "password": self.password},
+            headers=token_headers,
+        )
+        data = response.json()
+        self.token = data["token"]
+        self.token_expiry = time.time() + data["exp"]
+        self.headers["Authorization"] = f"Bearer {self.token}"
+
+        return TokenResponse(token=self.token, exp=data["exp"])
+
+    def _is_token_valid(self) -> bool:
+        """
+        Check if the current token is still valid.
+
+        :return: True if the token is valid, False otherwise.
+        """
+        if self.token is not None and time.time() < self.token_expiry:
+            return True
+        else:
+            logger.debug("Token is invalid or expired.")
+            return False
+
+    def _ensure_token(self) -> None:
+        """
+        Ensure a valid token is available. Renew if necessary.
+
+        :return: None
+        """
+        logger.debug("Ensuring token is valid...")
+        if not self._is_token_valid():
+            self._get_token()
+
+    def get(self, endpoint: str, params: dict[str, Any] | None = None, ensure_token: bool = True) -> ApiResponse:
+        """
+        Perform a GET request.
+
+        :param endpoint: The API endpoint (relative to the base URL).
+        :param params: Optional query parameters.
+        :return: An ApiResponse object containing the response data.
+        """
+        logger.debug(f"GET request to {endpoint} with params: {params}")
+        if ensure_token:
+            self._ensure_token()
+
+        url = f"{self.base_url}/{endpoint}/"
+        response = requests.get(url, params=params, headers=self.headers)
+        response.raise_for_status()
+        return response
+
+    def post(
+        self,
+        endpoint: str,
+        data: dict[str, Any] | None = None,
+        json: dict[str, Any] | None = None,
+        headers: dict[str, Any] | None = None,
+    ) -> requests.Response:
+        """
+        Perform a POST request.
+
+        :param endpoint: The API endpoint (relative to the base URL).
+        :param data: Optional form data to send in the body.
+        :param json: Optional JSON data to send in the body.
+        :return: The response object.
+        """
+        logger.debug(f"POST request to {endpoint} with data: {data}, json: {json}")
+        url = f"{self.base_url}/{endpoint}/"
+        response = requests.post(url, headers=headers, data=data, json=json)
+        response.raise_for_status()
+        return response
+
+    def get_brewery_overview(self) -> BreweryOverview:
+        """
+        Fetch the BreweryOverview from the API.
+
+        :return: A BreweryOverview object containing the brewery overview data.
+        """
+        logger.debug("Fetching brewery overview...")
+        response = self.get("v1/breweryoverview")
+        return BreweryOverview(**response.json())
+
+    def get_session_info(self, sessionid: int) -> Session:
+        """
+        Fetch session information from the API.
+
+        :param sessionid: The session ID to include in the query string.
+        :return: A Session object containing the session information.
+        """
+        logger.debug(f"Fetching session info for session ID: {sessionid}")
+        response = self.get(f"v1/sessions/{sessionid}")
+        return Session(**response.json())

pymbrewclient/rest/models.py

@@ -0,0 +1,164 @@
+# “Commons Clause” License Condition v1.0
+#
+# The Software is provided to you by the Licensor under the License, as defined below, subject to the following condition.
+#
+# Without limiting other conditions in the License, the grant of rights under the License will not include, and the License does not grant to you, the right to Sell the Software.
+#
+# For purposes of the foregoing, “Sell” means practicing any or all of the rights granted to you under the License to provide to third parties, for a fee or other consideration (including without limitation fees for hosting or consulting/ support services related to the Software), a product or service whose value derives, entirely or substantially, from the functionality of the Software. Any license notice or attribution required by the License must also include this Commons Clause License Condition notice.
+#
+# Software: pymbrewclient
+# License: MIT License
+# Licensor: Stuart Pearson
+#
+#
+# MIT License
+#
+# Copyright (c) 2024 Stuart Pearson
+#
+# 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.
+#
+# Disclaimer: This software is an independent project and is not affiliated with, endorsed by, or associated with MiniBrew. MiniBrew's trademarks, logos, API, and other intellectual property are owned by MiniBrew and are not included in this software. Users are responsible for complying with MiniBrew's terms of service when using this software.
+from dataclasses import dataclass
+
+
+@dataclass
+class Device:
+    uuid: str
+    serial_number: str
+    device_type: int
+    user_action: int
+    process_type: int
+    title: str
+    sub_title: str
+    session_id: int | None
+    image: str
+    status_time: int | None
+    stage: str
+    beer_name: str | None
+    recipe_version: str | None
+    beer_style: str | None
+    gravity: str
+    target_temp: float | None
+    current_temp: float | None
+    online: bool
+    updating: bool
+    needs_acid_cleaning: bool
+    is_starting: bool | None
+    software_version: str
+
+
+@dataclass
+class BreweryOverview:
+    brew_clean_idle: list[Device]
+    fermenting: list[Device]
+    serving: list[Device]
+    brew_acid_clean_idle: list[Device]
+
+
+@dataclass
+class Beer:
+    id: int
+    name: str
+    image: str | None
+    style_name: str
+
+
+@dataclass
+class DeviceDetails:
+    uuid: str
+    serial_number: str
+    current_state: int
+    process_type: int
+    process_state: int
+    user_action: int
+    device_type: int
+    connection_status: int
+    last_time_online: str
+    software_version: str
+    custom_name: str
+
+
+class Session:
+    def __init__(
+        self,
+        id: int,
+        profile: int,
+        beer: dict,
+        device: dict,
+        status: int,
+        session_type: int,
+        pending_command_seq: int,
+        pending_command_type: int,
+        pending_command_error: int,
+        beer_recipe_id: int,
+        beer_recipe_version: str,
+        brew_timestamp: float,
+        original_gravity: float,
+        timestamp_original_gravity: float,
+        is_brewpack: bool,
+    ) -> None:
+        self.id = id
+        self.profile = profile
+        self.beer = Beer(**beer)  # Convert the beer dictionary into a Beer object
+        self.device = DeviceDetails(**device)  # Convert the device dictionary into a DeviceDetails object
+        self.status = status
+        self.session_type = session_type
+        self.pending_command_seq = pending_command_seq
+        self.pending_command_type = pending_command_type
+        self.pending_command_error = pending_command_error
+        self.beer_recipe_id = beer_recipe_id
+        self.beer_recipe_version = beer_recipe_version
+        self.brew_timestamp = brew_timestamp
+        self.original_gravity = original_gravity
+        self.timestamp_original_gravity = timestamp_original_gravity
+        self.is_brewpack = is_brewpack
+
+    def __repr__(self) -> str:
+        return (
+            f"Session(\n"
+            f"  id={self.id},\n"
+            f"  profile={self.profile},\n"
+            f"  beer={self.beer},\n"
+            f"  device={self.device},\n"
+            f"  status={self.status},\n"
+            f"  session_type={self.session_type},\n"
+            f"  pending_command_seq={self.pending_command_seq},\n"
+            f"  pending_command_type={self.pending_command_type},\n"
+            f"  pending_command_error={self.pending_command_error},\n"
+            f"  beer_recipe_id={self.beer_recipe_id},\n"
+            f"  beer_recipe_version={self.beer_recipe_version},\n"
+            f"  brew_timestamp={self.brew_timestamp},\n"
+            f"  original_gravity={self.original_gravity},\n"
+            f"  timestamp_original_gravity={self.timestamp_original_gravity},\n"
+            f"  is_brewpack={self.is_brewpack}\n"
+            f")"
+        )
+
+
+@dataclass
+class TokenResponse:
+    token: str
+    exp: int
+
+
+@dataclass
+class ApiResponse:
+    status_code: int
+    data: dict | None
+    message: str | None

pymbrewclient-1.0.3.dist-info/METADATA

@@ -0,0 +1,120 @@
+Metadata-Version: 2.4
+Name: pymbrewclient
+Version: 1.0.3
+Summary: pymbrewclient: A Python library and CLI for readonly access to Minibrew's API
+Author-email: Stuart Pearson <1926002+stuartp44@users.noreply.github.com>
+License: MIT
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pydantic<3,>=1.10.17
+Requires-Dist: requests<3,>=2.32.3
+Requires-Dist: loguru<1,>=0.7.2
+Requires-Dist: typer<1,>=0.12.5
+Requires-Dist: rich<14,>=13.9.4
+Provides-Extra: dev
+Requires-Dist: pytest<8,>=7.4.0; extra == "dev"
+Requires-Dist: requests-mock<2,>=1.11.0; extra == "dev"
+Requires-Dist: pytest-cov<5,>=4.1.0; extra == "dev"
+Requires-Dist: black<24,>=23.9.1; extra == "dev"
+Requires-Dist: Flask<3,>=2.3.3; extra == "dev"
+Requires-Dist: ruff<1,>=0.7.2; extra == "dev"
+Requires-Dist: pre-commit<5,>=4.0.1; extra == "dev"
+Provides-Extra: build
+Requires-Dist: build; extra == "build"
+Requires-Dist: twine; extra == "build"
+Dynamic: license-file
+
+# pymbrewclient
+
+`pymbrewclient` is a Python library and CLI tool for interacting with Minibrew's API. It provides both programmatic access and a command-line interface for fetching brewery and session information.
+
+---
+
+## Features
+
+- Fetch brewery overview data.
+- Retrieve session information.
+- Easy-to-use CLI for quick access.
+- Python library for programmatic integration.
+
+---
+
+### PLEASE NOTE
+This library will only work with a valid subscription to the pro portal.
+
+## Installation
+
+You can install `pymbrewclient` using `pip`:
+
+### CLI
+
+```bash
+pip install pymbrewclient
+```
+
+```bash
+pymbrewclient get-token --username <USERNAME> --password <PASSWORD>
+```
+
+```bash
+pymbrewclient brewery-overview
+```
+
+```bash
+pymbrewclient session-info --username <USERNAME> --password <PASSWORD> --session-id <SESSION_ID>
+```
+
+### Library Usage
+
+```python
+from pymbrewclient import pymbrewclient
+
+# Initialize the client
+client = pymbrewclient(username,password)
+
+# Fetch brewery overview
+brewery_overview = client.get_brewery_overview()
+print(brewery_overview)
+```
+
+```python
+from pymbrewclient import pymbrewclient
+
+# Initialize the client
+client = pymbrewclient()
+
+# Fetch session info
+session_id = 12345
+session_info = client.get_session_info(session_id)
+print(session_info)
+```
+
+
+## Development
+
+Clone the repository:
+```
+git clone https://github.com/yourusername/pymbrewclient.git
+cd pymbrewclient
+```
+
+Install dependencies:
+```
+pip install .[dev]
+```
+
+Run tests:
+```
+pytest
+```
+
+Lint the code:
+```
+make lint
+```

pymbrewclient-1.0.3.dist-info/RECORD

@@ -0,0 +1,12 @@
+pymbrewclient/__init__.py,sha256=CYwZdlZaPG0qLmk2Wl4RK-iluTkW-XoMHPEr8JXDi9Y,2411
+pymbrewclient/cli.py,sha256=WFd5Jyd69vtXgoE-ETJZJsGjXDFqEYy4Bo0gjojXPhI,11226
+pymbrewclient/pymbrewclient.py,sha256=YYjPxFrCj4cJf9LEb47eCYD2ncUrsIO5_Xq4jc-yWGo,3981
+pymbrewclient/rest/__init__.py,sha256=CYwZdlZaPG0qLmk2Wl4RK-iluTkW-XoMHPEr8JXDi9Y,2411
+pymbrewclient/rest/client.py,sha256=wZJg-5SjstAG-G4ohE_WKyt6WhpziXYKhH8MXQNN9Cw,6955
+pymbrewclient/rest/models.py,sha256=WM3x5H2Np9n8ocpgJUfrfH5h2G_ZN-ymFSQ5thwPups,5884
+pymbrewclient-1.0.3.dist-info/licenses/LICENSE,sha256=R78D6QNQpdNRV58w-rVOzZ-2HrBBHZY5hg2POFxJYUs,2349
+pymbrewclient-1.0.3.dist-info/METADATA,sha256=4q_pG9PHoeY781FSnO6vgw1JGjQi9hiNkle_X5jH1aY,2739
+pymbrewclient-1.0.3.dist-info/WHEEL,sha256=ck4Vq1_RXyvS4Jt6SI0Vz6fyVs4GWg7AINwpsaGEgPE,91
+pymbrewclient-1.0.3.dist-info/entry_points.txt,sha256=ywNMpadMTU-kFcbgQp25rlM1cbPLFaFwDIec0HKrK0A,56
+pymbrewclient-1.0.3.dist-info/top_level.txt,sha256=u5AIf2yjh3UGeGGxgvafIuw7Vw9Bgz4oI75NVEMikdU,14
+pymbrewclient-1.0.3.dist-info/RECORD,,

pymbrewclient-1.0.3.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.0.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

pymbrewclient-1.0.3.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+pymbrewclient = pymbrewclient.cli:app

pymbrewclient-1.0.3.dist-info/licenses/LICENSE

@@ -0,0 +1,36 @@
+“Commons Clause” License Condition v1.0
+
+The Software is provided to you by the Licensor under the License, as defined below, subject to the following condition.
+
+Without limiting other conditions in the License, the grant of rights under the License will not include, and the License does not grant to you, the right to Sell the Software.
+
+For purposes of the foregoing, “Sell” means practicing any or all of the rights granted to you under the License to provide to third parties, for a fee or other consideration (including without limitation fees for hosting or consulting/ support services related to the Software), a product or service whose value derives, entirely or substantially, from the functionality of the Software. Any license notice or attribution required by the License must also include this Commons Clause License Condition notice.
+
+Software: pymbrewclient
+License: MIT License
+Licensor: Stuart Pearson
+
+
+MIT License
+
+Copyright (c) 2024 Stuart Pearson
+
+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.
+
+Disclaimer: This software is an independent project and is not affiliated with, endorsed by, or associated with MiniBrew. MiniBrew's trademarks, logos, API, and other intellectual property are owned by MiniBrew and are not included in this software. Users are responsible for complying with MiniBrew's terms of service when using this software.

pymbrewclient-1.0.3.dist-info/top_level.txt

@@ -0,0 +1 @@
+pymbrewclient