hookee 1.0.0

Command line webhooks, on demand.

hookee - command line webhooks, on demand

hookee is a utility that provides command line webhooks, on demand! Dump useful request data to the console, process requests and responses, customize response data, and configure hookee and its routes further in any number of ways through custom plugins.

Installation

hookee is available on PyPI and can be installed using pip:

pip install hookee

or conda:

conda install -c conda-forge hookee

That's it! hookee is now available on the command line and as a package to our Python projects.

Basic Usage

This package puts hookee on our path, so it can be used by simply executing it from the command line.

hookee start

This will start a server on the default port 5000, open a ngrok tunnel to this server using pyngrok, and mount a URL at /webhook. Sending any request to the /webhook endpoint will dump the request and response content to the console.

We can also customize the response from /webhook, quick and dirty, using the --response arg.

hookee --response "<Response>Ok</Response>" --content-type application/xml

For more advanced customization of requests, responses, and available routes, refer to the documentation.

Documentation

For more advanced usage, including extending hookee through plugins, hookee's official documentation is available at http://hookee.readthedocs.io.

Contributing

If you would like to get involved, be sure to review the Contribution Guide.

Want to contribute financially? If you've found hookee useful, a donation would also be greatly appreciated!