Skip to main content

Beer-garden plugin and utility library

Project description

Brewtils is the Python library for interfacing with Beergarden systems. If you are planning on writing beer-garden plugins, this is the correct library for you. In addition to writing plugins, it provides simple ways to query the API and is officially supported by the beer-garden team.

Gitter PyPI Build Status Code Coverage Documentation Status Pyup Updates

Features

Brewtils helps you interact with beer-garden.

  • Easy way to create beer-garden plugins

  • Full support of the entire Beer-Garden API

  • Officially supported by the beer-garden team

Installation

To install brewtils, run this command in your terminal:

$ pip install brewtils

Or add it to your requirements.txt

$ cat brewtils >> requirements.txt
$ pip install -r requirements.txt

Quick Start

You can create your own beer-garden plugins without much problem at all. To start, we’ll create the obligatory hello-world plugin. Creating a plugin is as simple as:

from brewtils.decorators import system, parameter, command
from brewtils.plugin import RemotePlugin

@system
class HelloWorld(object):

    @parameter(key="message", description="The message to echo", type="String")
    def say_hello(self, message="World!"):
        print("Hello, %s!" % message)
        return "Hello, %s!" % message

if __name__ == "__main__":
    client = HelloWorld()
    plugin = RemotePlugin(client,
                          name="hello",
                          version="0.0.1",
                          bg_host='127.0.0.1',
                          bg_port=2337)
    plugin.run()

Assuming you have a Beer Garden running on port 2337 on localhost, running this will register and start your plugin! You now have your first plugin running in beer-garden. Let’s use another part of the brewtils library to exercise your plugin from python.

The SystemClient is designed to help you interact with registered Systems as if they were native Python objects.

from brewtils.rest.system_client import SystemClient

hello_client = SystemClient('localhost', 2337, 'hello')

request = hello_client.say_hello(message="from system client")

print(request.status) # 'SUCCESS'
print(request.output) # Hello, from system client!

In the background, the SystemClient has executed an HTTP POST with the payload required to get beer-garden to execute your command. The SystemClient is how most people interact with beer-garden when they are in the context of python and want to be making requests.

Of course, the rest of the API is accessible through the brewtils package. The EasyClient provides simple convenient methods to call the API and auto-serialize the responses. Suppose you want to get a list of all the commands on all systems:

from brewtils.rest.easy_client import EasyClient

client = EasyClient('localhost', 2337)

systems = client.find_systems()

for system in systems:
    for command in system.commands:
        print(command.name)

This is just a small taste of what is possible with the EasyClient. Feel free to explore all the methods that are exposed.

For more detailed information and better walkthroughs, checkout the full documentation!

Documentation

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

brewtils-3.28.0.tar.gz (101.1 kB view details)

Uploaded Source

Built Distribution

brewtils-3.28.0-py2.py3-none-any.whl (113.7 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file brewtils-3.28.0.tar.gz.

File metadata

  • Download URL: brewtils-3.28.0.tar.gz
  • Upload date:
  • Size: 101.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for brewtils-3.28.0.tar.gz
Algorithm Hash digest
SHA256 d341d01b27644aec4868b81296c4d3a72bcc95ccade96da73daf5dc06485d128
MD5 35d5e394f3940f3422a89bf82e8415e9
BLAKE2b-256 e146d071f2f99f003d99ddc95e2a423aa5e41dcc0e477487727a77e10087bcaf

See more details on using hashes here.

File details

Details for the file brewtils-3.28.0-py2.py3-none-any.whl.

File metadata

  • Download URL: brewtils-3.28.0-py2.py3-none-any.whl
  • Upload date:
  • Size: 113.7 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for brewtils-3.28.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 813a3a5000017b065c015013530e1001c75608d96ef5139800fee1af58dede57
MD5 185c30db0ed5332114b31710f7902d35
BLAKE2b-256 b28468e208789ba48bb124cfa70b3b08fbe8db4c4a1ebb19f3627a16998b4824

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page