This will be a python module to allow for easy creation of plugins. It's already fairly easy, but this can improve upon that! I'm hoping to (along with putting a Python executable on the path, and assuming other modules) to also try compiling into a single binary. I've never done this before, so stay tuned!
A basic filter plugin will instantiate the FilterPlugin class, and then
provide a function to run for the filter.
#!/usr/bin/env python3
from nushell.filter import FilterPlugin
# Your filter function will be called by the FilterPlugin, and should
# accept the plugin and the dictionary of params
def runFilter(plugin, params):
'''runFilter will be executed by the calling SinkPlugin when method is "sink"
'''
# Get the string primitive passed by the user
value = plugin.get_string_primitive()
# Calculate the length
intLength = len(value)
# Print an integer response (can also be print_string_response)
plugin.print_int_response(intLength)
# The main function is where you create your plugin and run it.
def main():
# Initialize a new plugin
plugin = FilterPlugin(name="len",
usage="Return the length of a string")
# Run the plugin by passing your filter function
plugin.run(runFilter)
if __name__ == '__main__':
main()Notably, your filter function should taken a plugin and parsed command line
parameters (dictionary) as arguments. You can use the plugin to perform
several needed functions to send responses back to nushell, or log to /tmp/nushell-plugin-<name>.log:
plugin.logger.<level>
plugin.get_string_primitive()
plugin.get_int_primitive()
plugin.print_int_response()
plugin.print_string_response()- len is a basic function to return the length of a string
A sink plugin will instantiate the SinkPlugin class, and then hand off
stdin (via a temporary file) to a sink function that you write.
Here is a dummy example.
#!/usr/bin/env python3
from nushell.sink import SinkPlugin
# Your sink function will be called by the sink Plugin, and should
# accept the plugin and the dictionary of params
def sink(plugin, params):
'''sink will be executed by the calling SinkPlugin when method is "sink"
'''
message = "Hello"
excited = params.get("excited", False)
name = params.get("name", "")
# If we have a name, add to message
message = "%s %s" %(message, name)
# Are we excited?
if excited:
message += "!"
print(message)
# The main function is where you create your plugin and run it.
def main():
# Initialize a new plugin
plugin = SinkPlugin(name="hello",
usage="A friendly plugin")
# Add named arguments (notice we check for in params in sink function)
# add_named_argument(name, argType, syntaxShape=None, usage=None)
plugin.add_named_argument("excited", "Switch", usage="add an exclamation point!")
plugin.add_named_argument("name", "Optional", "String", usage="say hello to...")
# Run the plugin by passing your sink function
plugin.run(sink)
if __name__ == '__main__':
main()This code is licensed under the MPL 2.0 LICENSE.
Please contribute to the package, or post feedback and questions as issues.