pymbrewclient: A Python library and CLI for readonly access to Minibrew's API
Project description
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
pip install pymbrewclient
pymbrewclient get-token --username <USERNAME> --password <PASSWORD>
pymbrewclient brewery-overview
pymbrewclient session-info --username <USERNAME> --password <PASSWORD> --session-id <SESSION_ID>
Library Usage
from pymbrewclient.client import BreweryClient
# Initialize the client
client = pymbrewclient(username,password)
# Fetch brewery overview
brewery_overview = client.get_brewery_overview()
print(brewery_overview)
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
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
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file pymbrewclient-1.0.10.tar.gz.
File metadata
- Download URL: pymbrewclient-1.0.10.tar.gz
- Upload date:
- Size: 13.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.12.10
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
a4cecfc224bc3df73ac528ca8f5def1501618521850fdd6f849bf0a35c1c1c9b
|
|
| MD5 |
a9e579c92564b838f06c8d211e5910d1
|
|
| BLAKE2b-256 |
412ac6d8155a05b3472854724aded821e95bf329e585a3173ba7b92034d63bf3
|
File details
Details for the file pymbrewclient-1.0.10-py3-none-any.whl.
File metadata
- Download URL: pymbrewclient-1.0.10-py3-none-any.whl
- Upload date:
- Size: 16.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.12.10
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
3dfb002fa65838076daa4db423935067278812a6836e1b24b5c26e265d0196b3
|
|
| MD5 |
48c9b7df89c139b372a48911f240cebe
|
|
| BLAKE2b-256 |
a640828aa041f5ce0343a998cd3cc73e79a193493cf31f4027f5ae527f9f0d27
|