pymbrewclient 1.0.3__tar.gz

pymbrewclient-1.0.3/.github/workflows/test-and-release.yml

@@ -0,0 +1,121 @@
+name: Test and Release
+
+on:
+  pull_request:
+    types: [opened, synchronize, reopened] # Trigger when a PR is opened, updated, or reopened
+  push:
+    tags:
+      - "v*" # Trigger on version tags (e.g., v1.0.0)
+  workflow_dispatch: # Allow manual triggering of the workflow
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+        with:
+            fetch-depth: 0
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.12"
+
+      - name: Install dependencies
+        run: |
+          pip install --upgrade pip
+          pip install .[dev]
+
+      - name: Run tests with coverage
+        run: |
+          pytest --cov=pymbrewclient --cov-report=term-missing --cov-report=xml
+
+      - name: Upload coverage report
+        uses: actions/upload-artifact@v4
+        with:
+          name: coverage-report
+          path: coverage.xml
+
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.12"
+
+      - name: Install dependencies
+        run: |
+          pip install --upgrade pip
+          pip install .[dev]
+
+      - name: Run ruff
+        run: ruff check .
+
+      - name: Run black
+        run: black --check .
+
+  build:
+    runs-on: ubuntu-latest
+    needs: [test, lint] # Only run if test and lint jobs succeed
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0 # Ensure all tags are fetched for setuptools_scm
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.12"
+
+      - name: Install build tools
+        run: |
+          pip install --upgrade pip
+          pip install build twine
+
+      - name: Build package
+        run: python -m build
+
+      - name: Upload build artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: build-artifacts
+          path: dist/
+
+  release:
+    runs-on: ubuntu-latest
+    needs: [build] # Only run if the build job succeeds
+    if: startsWith(github.ref, 'refs/tags/v') # Only run for version tags
+    permissions:
+      contents: read
+      id-token: write # Required for OIDC authentication
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0 # Ensure all tags are fetched for setuptools_scm
+      
+      - name: Download build artifacts
+        uses: actions/download-artifact@v4
+        with:
+            name: build-artifacts
+            path: dist/
+      
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.12"
+
+      - name: Install twine
+        run: pip install twine
+
+      - name: Publish to PyPI using OIDC
+        env:
+          TWINE_REPOSITORY_URL: "https://upload.pypi.org/legacy/"
+        run: |
+          python -m twine upload dist/*

pymbrewclient-1.0.3/.gitignore

@@ -0,0 +1,177 @@
+# 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
+
+# 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/
+
+
+# ignore java class files -> theres a small bit of java code in the repo
+*.class
+
+# venvs
+venv*/
+activate
+
+# sandbox scripts
+sandbox/
+
+# vim files
+*.swo
+*.swp

pymbrewclient-1.0.3/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/Makefile

@@ -0,0 +1,53 @@
+# Variables
+PYTHON = python
+PIP = $(PYTHON) -m pip
+COVERAGE = coverage
+PYTEST = pytest
+REQ_FILE = requirements.txt
+SRC_DIR = pymbrewclient
+TEST_DIR = tests
+DIST_DIR = dist
+COV_REPORT_DIR = htmlcov
+
+# Default target
+.PHONY: all
+all: test
+
+# Install dependencies
+.PHONY: install
+install:
+    $(PIP) install --upgrade pip
+    $(PIP) install -r $(REQ_FILE)
+    $(PIP) install pytest coverage
+
+# Run tests with coverage
+.PHONY: test
+test:
+    $(COVERAGE) run -m $(PYTEST)
+    $(COVERAGE) report
+    $(COVERAGE) xml
+    $(COVERAGE) html
+
+# Clean up coverage and build artifacts
+.PHONY: clean
+clean:
+    rm -rf $(COV_REPORT_DIR) $(DIST_DIR) .coverage coverage.xml
+
+# Build the package
+.PHONY: build
+build:
+    $(PYTHON) setup.py sdist bdist_wheel
+
+# Run linting (optional)
+.PHONY: lint
+lint:
+    flake8 $(SRC_DIR) $(TEST_DIR)
+
+# Run all checks (tests + linting)
+.PHONY: check
+check: lint test
+
+# Run semantic commit validation
+.PHONY: validate-commit
+validate-commit:
+    git log -1 --pretty=%B | grep -E '^(feat|fix|chore|docs|style|refactor|perf|test|ci|build): .+' || exit 1

pymbrewclient-1.0.3/PKG-INFO

@@ -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/README.md

@@ -0,0 +1,88 @@
+# 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/pyproject.toml

@@ -0,0 +1,61 @@
+[build-system]
+requires = ["setuptools>=61.0", "wheel", "build", "setuptools_scm"]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools_scm]
+version_scheme = "post-release"
+local_scheme = "node-and-date"
+
+[project]
+name = "pymbrewclient"
+description = "pymbrewclient: A Python library and CLI for readonly access to Minibrew's API"
+readme = {file = "README.md", content-type = "text/markdown"}
+requires-python = ">=3.10"
+license = {text = "MIT"}
+authors = [{name = "Stuart Pearson", email = "1926002+stuartp44@users.noreply.github.com"}]
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent"
+]
+dependencies = [
+    "pydantic>=1.10.17,<3",
+    "requests>=2.32.3,<3",
+    "loguru>=0.7.2,<1",
+    "typer>=0.12.5,<1",
+    "rich>=13.9.4,<14",
+]
+dynamic = ["version"]
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=7.4.0,<8",
+    "requests-mock>=1.11.0,<2",
+    "pytest-cov>=4.1.0,<5",
+    "black>=23.9.1,<24",
+    "Flask>=2.3.3,<3",
+    "ruff>=0.7.2,<1",
+    "pre-commit>=4.0.1,<5",
+]
+build = [
+    "build",
+    "twine",
+]
+
+[project.scripts]
+pymbrewclient = "pymbrewclient.cli:app"
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+addopts = "--cov=pymbrewclient --cov-report=term-missing --cov-report=xml"
+
+[tool.ruff]
+line-length = 120
+select = ["E", "F", "ANN", "UP"]
+ignore = ["E501", "ANN101"]
+
+[tool.black]
+line-length = 120
+target-version = ["py312"]

pymbrewclient-1.0.3/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

pymbrewclient-1.0.3/src/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.