Merge pull request #32 from beer-garden/Parameters_Example

Creating new client example

parameters/beer.conf

@@ -0,0 +1 @@
+PLUGIN_ENTRY="-m parameters"

parameters/parameters/__main__.py

@@ -0,0 +1,198 @@
+import sys
+from datetime import datetime
+from typing import Literal
+
+from brewtils import Plugin, command, parameter
+
+__version__ = "3.0.0.dev0"
+
+
+class ParametersClient(object):
+    """Client that shows different options to declaring parameters"""
+
+    @command()
+    def any_default(self, value):
+        """Any is the default type for any undeclared variables"""
+        return value
+
+    @parameter(key="value", type="String")
+    def string_parameter(self, value):
+        """Parameter: string value"""
+        return value
+
+    @command()
+    def string_type_hint(self, value: str):
+        """Type Hint: String value"""
+        return value
+
+    @command()
+    def string_doc_string(self, value):
+        """Doc String: String value
+        Args:
+            value (str): A value of String type
+        """
+        return value
+
+    if sys.version_info.major == 3 and sys.version_info.minor >= 8:
+
+        @command()
+        def string_type_hint_choices(self, value: Literal["value1", "value2"]):
+            """Type Hint: String value"""
+            return value
+
+    @parameter(key="value", type="Integer")
+    def int_parameter(self, value):
+        """Parameter: int value"""
+        return value
+
+    @command()
+    def int_type_hint(self, value: int):
+        """Type Hint: int value"""
+        return value
+
+    if sys.version_info.major == 3 and sys.version_info.minor >= 8:
+
+        @command()
+        def int_type_hint_choices(self, value: Literal[1, 2]):
+            """Type Hint: String value"""
+            return value
+
+    @command()
+    def int_doc_string(self, value):
+        """Doc String: int value
+        Args:
+            value (int): A value of int type
+        """
+        return value
+
+    @parameter(key="value", type="Float")
+    def float_parameter(self, value):
+        """Parameter: float value"""
+        return value
+
+    @command()
+    def float_type_hint(self, value: float):
+        """Type Hint: float value"""
+        return value
+
+    @command()
+    def float_doc_string(self, value):
+        """Doc String: float value
+        Args:
+            value (float): A value of float type
+        """
+        return value
+
+    @parameter(key="value", type="Boolean")
+    def bool_parameter(self, value):
+        """Parameter: bool value"""
+        return value
+
+    @command()
+    def bool_type_hint(self, value: bool):
+        """Type Hint: bool value"""
+        return value
+
+    @command()
+    def bool_doc_string(self, value):
+        """Doc String: bool value
+        Args:
+            value (bool): A value of bool type
+        """
+        return value
+
+    @parameter(key="value", type="Dictionary")
+    def dict_parameter(self, value):
+        """Parameter: dict value"""
+        return value
+
+    @command()
+    def dict_type_hint(self, value: dict):
+        """Type Hint: dict value"""
+        return value
+
+    @command()
+    def dict_output_type_hint(self, value: dict) -> dict:
+        """Type Hint: default output to JSON for class type dict"""
+        return value
+
+    @command()
+    def dict_doc_string(self, value):
+        """Doc String: dict value
+        Args:
+            value (dict): A value of dict type
+        """
+        return value
+
+    @command()
+    def obj_type_hint(self, value: object):
+        """Type Hint: object value (same input as dict)"""
+        return value
+
+    @command()
+    def obj_output_type_hint(self, value: object) -> object:
+        """Type Hint: default output to JSON for class type object"""
+        return value
+
+    @command()
+    def obj_doc_string(self, value):
+        """Doc String: object value (same input as dict)
+        Args:
+            value (object): A value of dict type
+        """
+        return value
+
+    @parameter(key="value", type="DateTime")
+    def date_time_parameter(self, value):
+        """Parameter: datetime value"""
+        return value
+
+    @command()
+    def date_time_type_hint(self, value: datetime):
+        """Type Hint: datetime value"""
+        return value
+
+    @command()
+    def date_time_doc_string(self, value):
+        """Doc String: datetime value
+        Args:
+            value (datetime): A value of datetime type
+        """
+        return value
+
+    @parameter(key="value", type="Bytes")
+    def bytes_parameter(self, value):
+        """Parameter: bytes value"""
+        return value
+
+    @command()
+    def bytes_type_hint(self, value: bytes):
+        """Type Hint: bytes value"""
+        return value
+
+    @command()
+    def bytes_doc_string(self, value):
+        """Doc String: bytes value
+        Args:
+            value (bytes): A value of bytes type
+        """
+        return value
+
+    @parameter(key="value", type="Base64")
+    def base64_parameter(self, value):
+        """Parameter: base64 value"""
+        return value
+
+
+def main():
+    plugin = Plugin(
+        name="parameters",
+        version=__version__,
+        description="Client that shows different options to declaring parameters",
+    )
+    plugin.client = ParametersClient()
+    plugin.run()
+
+
+if __name__ == "__main__":
+    main()

parameters/setup.py

@@ -0,0 +1,37 @@
+import re
+
+from setuptools import setup
+
+
+def find_version(version_file):
+    version_line = open(version_file, "rt").read()
+    match_object = re.search(r"^__version__ = ['\"]([^'\"]*)['\"]", version_line, re.M)
+
+    if not match_object:
+        raise RuntimeError("Unable to find version string in %s" % version_file)
+
+    return match_object.group(1)
+
+
+setup(
+    name="parameters",
+    version=find_version("parameters/__main__.py"),
+    description="Client that shows different options to declaring parameters",
+    url="https://beer-garden.io",
+    author="The Beergarden Team",
+    author_email=" ",
+    license="MIT",
+    packages=["parameters"],
+    install_requires=["brewtils"],
+    classifiers=[
+        "Intended Audience :: Developers",
+        "License :: OSI Approved :: MIT License",
+        "Programming Language :: Python :: 2",
+        "Programming Language :: Python :: 2.7",
+        "Programming Language :: Python :: 3",
+        "Programming Language :: Python :: 3.5",
+        "Programming Language :: Python :: 3.6",
+        "Programming Language :: Python :: 3.7",
+        "Programming Language :: Python :: 3.8",
+    ],
+)