Skip to main content

tools for your toolbox , neatly organised

Project description

Toolbox

https://img.shields.io/pypi/v/tool-box.svg https://img.shields.io/travis/jeff-99/toolbox.svg Documentation Status

What is Toolbox ?

Toolbox is a framework to manage a collection of tools. A tool can be anything from a shell script to a python package.

Basically toolbox extends the python argparse.ArgumentParser to enable importing tools from multiple locations in a single executable. Toolbox provides some easy default tools to create , install, uninstall or list (available) tools.

A custom tool needs to implement 2 methods: * prepare_parser : which prepares an argparse.ArgumentParser * execute : which is the main entry point of your tool

Besides the wrapper around argument parsing toolbox as a framework provides some easy to add extra’s like persisted configuration, usage of tools within tools and no-configuration logging.

An example of a custom tool:

from toolbox.plugin import ToolboxPlugin
from toolbox.mixins import RegistryMixin, ConfigMixin, LogMixin

class CustomPlugin(RegistryMixin, ConfigMixin, LogMixin, ToolboxPlugin)
        name = "custom"
        description = "This is a custom plugin that prints a string"

        def prepare_parser(self,parser):
                parser.add_argument('printable', help="string to print")

        def execute(args):
                # LogMixin
                logger = self.get_logger()
                logger.info("printing {}".format(args.printable)

                # ConfigMixin
                config = self.get_config()
                config['first_print'] = args.printable

                # RegistryMixin
                registry = self.get_registry()
                other_plugin = registry.get_plugin('other')

                print(args.printable)

For more info on all the tools the toolbox framework provides check the complete documentation!

Features

  • Integrate your own shell scripts etc. with a single command
  • Easily integrate your existing python tools with toolbox by wrapping them in ToolboxPlugin class
  • Add persisted configuration to your tools
  • Use other tools within your own tools
  • search tools in the toolbox
  • install other tools from PyPI/github with the toolbox commandline

Credits

This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.

History

0.5.0 (2016-01-02)

  • added logs tool
  • added tests for the registry , scanner and config

0.4.0 (2016-01-01)

  • First stable release on PyPI.

Project details


Download files

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

Source Distribution

tool-box-0.5.1.tar.gz (26.4 kB view hashes)

Uploaded source

Built Distribution

tool_box-0.5.1-py2.py3-none-any.whl (25.5 kB view hashes)

Uploaded 3 4

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page