Package: pipen-board
pipen-boardVisualize configuration and running ofpipenpipelines on the web.Installationpipinstallpipen-boardUsage$pipenboard--help
Usage:pipenboard[options]<pipeline>--[pipelineoptions]Configureandrunpipenpipelinesfromtheweb

RequiredArguments:pipelineThepipelineandtheCLIargumentstorunthepipeline.Forthepipelineeither`/path/to/pipeline.py:<pipeline>`or`<module.submodule>:<pipeline>``<pipeline>`mustbeaninstanceof`Pipen`andrunningthepipelineshouldbecalledunder`__name__=='__main__'.

OptionalArguments:-h,--helpshowhelpmessageandexit-pPORT,--portPORTPorttoservetheUIwizard[default:18521]-aFILE,--additionalFILEAdditionalargumentsforthepipeline,inYAML,INI,JSONorTOMLformat.Canhavesections`ADDITIONAL_OPTIONS`and`RUNNING_OPTIONS`.Itcanalsohaveothersectionsanditemstooverridetheconfigurationsgeneratedfromthepipeline.Ifthepipelineisprovidedasapythonscript,suchas`/path/to/pipeline.py:<pipeline>`,and`<pipeline>`runsunder`__name__=='__main__'`,theadditionalfilecanalsobespecifiedas`auto`togeneratea`RUNNINGOPTIONS/Local`sectiontorunthepipelinelocally.--loglevel{auto,debug,info,warning,error,critical}Thelogginglevel.If`auto`,itwillbesetto`debug`if`--dev`isset,otherwise`info`.[default:auto]--devRunthepipelineindevelopment/debugmode.Thiswillreloadtheserverwhenchangesaremadetothispackageandreloadthepipelinewhenpagereloadsfornewconfigurations.Pagecacheisalsodisabledinthismode.-wWORKDIR,--workdirWORKDIRTheworkingdirectoryofthepipeline.[default:.pipen]-sSCHEMA_DIR,--schema-dirSCHEMA_DIRThedirectorytostoretheconfigurationschemas.[default:~/.pipen-board]Describing arguments in docstringDocstring schemaclassProcessOrProcessGroup:"""Short summaryLong descriptionLong descriptionArgs:arg1 (<metadata>): description- subarg1 (<metadata>): description- subarg2 (<metadata>): descriptionarg2 (<metadata>): description<Other Sections>:<content>"""The metadata can have multiple attributes, separated by semicolon (;). For example:arg1 (action=ns;required): descriptionMarksYou can mark a process usingpipen.utils.mark(<mark>=<value>)as a decorator to decorate a process. For example:frompipenimportProcfrompipen.utilsimportmark@mark(board_config_no_input=True)classMyProc(Proc):passAvailable marks:board_config_no_input: Whether to show the input section for the process in configuation page. Only affects the start processes. Default toFalse.board_config_hidden: Whether to hide the process options in the configuration page. Note that the process is still visible in the process list. Default toFalse.Metadata for argumentsNameDescriptionAllowed valuesactionLike theactionargument inargx*.store_true,store_false,ns,namespace,append,extend,clear_append,clear_extend(other values are allowed but ignore, they may be effective for CLI use)btypeBoard type (option type specified directly). If specified,actionwill be ignoredns,choice,mchoice,array,list,json,int,float,bool,str,text,auto*typeFallback foractionandbtypeSame asbtypeflagFallback foraction=store_trueNo values neededtext/mline/mlinesShortcut forbtype=textNo values neededns/namespaceShortcut forbtype=nsNo values neededchoices/choiceShortcut forbtype=choiceNo values neededmchoices/mchoiceShortcut forbtype=mchoiceNo values neededarray/listShortcut forbtype=array/btype=listNo values neededchoices/choiceShortcut forbtype=choiceNo values neededmchoices/mchoiceShortcut forbtype=mchoiceNo values neededorderThe order of the argument in the UI.Any integerreadonlyWhether the argument is readonly.No values needed (True if specified, otherwise False)requiredWhether the argument is required.No values needed (True if specified, otherwise False)placeholderThe placeholder in the UI for the argument.Any stringbitypeThe type of the elements in an array or list.int,float,bool,str,json,auto*itypeFallback forbitypeSame asbitypeargx*: An argument parser for Python, compatible withargparse.auto*: Automatically infer the type from a string value.Any ofTrue,TRUE,true,False,FALSE,falsewill be inferred as aboolvalue.Any ofNone,NONE,none,null,NULLwill be inferred asNone.Any integers will be inferred asint.Any floats will be inferred asfloat.Try to parse the value as JSON. If succeed, the value will be inferred asjson.Otherwise, the value will be inferred asstr.Types of options in the UIThe type of an option in the UI is determined by thebtype,actionortypemetadata. If neither is specified, aPlainTextwill be used.BoolOption: Shown as a switchTextOption: Shown as a textarea (allow multiple lines)ChoiceOption: Shown as a dropdown list (subarg1andsubarg2in the example above are used as the choices)MChoiceOption: Shown as a multiple choice list (subarg1andsubarg2in the example above are used as the choices)JsonOption: Shown as a textarea, but the value will be validated and parsed as JSONArrayOption: Shown as a tag input. Items can be added or removed.AutoOption: Shown as a 1-row textarea, and the value will be parsed automaticallyPlainText: Shown as a plain text. No validation or parsing will be performed.MoreLikeOption: Show as a box with buttons to add or remove sub-options. It's usally used together withnstype. If there is a sub-option under the option in the docstring wrapped by<...>, it indicates that we may have more sub-options.