An open API service indexing awesome lists of open source software.

https://github.com/stuartp44/pymbrewclient

This repo allows your to interact with the minibrew pro portal to gain insights on brew status
https://github.com/stuartp44/pymbrewclient

Last synced: 2 months ago
JSON representation

This repo allows your to interact with the minibrew pro portal to gain insights on brew status

Awesome Lists containing this project

README

          

# 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.

## Disclaimer

This project is an independent, community-driven tool and is **not affiliated with, endorsed by, or supported by Minibrew**. It is developed and maintained by independent contributors.

## Requirements

This library will **only work** if you have access to Minibrew's Pro Portal subscription.

---

## Features

- Fetch brewery overview data.
- Retrieve session information.
- Easy-to-use CLI for quick access.
- Python library for programmatic integration.

## Installation

You can install `pymbrewclient` using `pip`:

### CLI

```bash
pip install pymbrewclient
```

```bash
pymbrewclient get-token --username --password
```

```bash
pymbrewclient brewery-overview
```

```bash
pymbrewclient session-info --username --password --session-id
```

### Library Usage

```python
from pymbrewclient.client import BreweryClient

# Initialize the client
client = pymbrewclient(username,password)

# Fetch brewery overview
brewery_overview = client.get_brewery_overview()
print(brewery_overview)
```

```python
from pymbrewclient.client import BreweryClient

# Initialize the client
client = pymbrewclient(username,password)

# 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
```