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.29.1.tar.gz (102.8 kB view details)

Uploaded Source

Built Distribution

brewtils-3.29.1-py2.py3-none-any.whl (115.4 kB view details)

Uploaded Python 2Python 3

File details

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

File metadata

  • Download URL: brewtils-3.29.1.tar.gz
  • Upload date:
  • Size: 102.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.0.1 CPython/3.12.8

File hashes

Hashes for brewtils-3.29.1.tar.gz
Algorithm Hash digest
SHA256 de895f7c9136e885d61435959fbc9ecd310e59db5fd6b406c07436d147b80787
MD5 7262b2147634970bf576ae22e3f7ffd7
BLAKE2b-256 d8d290a645fa63788b97a6d6c1731739863b247bd801158612d169e6b13aeb67

See more details on using hashes here.

Provenance

The following attestation bundles were made for brewtils-3.29.1.tar.gz:

Publisher: tag-actions.yml on beer-garden/brewtils

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

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

File metadata

  • Download URL: brewtils-3.29.1-py2.py3-none-any.whl
  • Upload date:
  • Size: 115.4 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.0.1 CPython/3.12.8

File hashes

Hashes for brewtils-3.29.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 79c44fc4b2f9b0452f64e9d174c805120eed9bdaada1a909981a8e8f7a1537ab
MD5 4b91e54e03898645de4fccb1ccda59ea
BLAKE2b-256 702179f0c643eefcc9913c8ffbc9b96cba0d71dfa6dde962a6237e1f40ae953e

See more details on using hashes here.

Provenance

The following attestation bundles were made for brewtils-3.29.1-py2.py3-none-any.whl:

Publisher: tag-actions.yml on beer-garden/brewtils

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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