Skip to main content

Command line webhooks, on demand.

Project description

hookee - command line webhooks, on demand

Version Python Versions Coverage Build Docs GitHub License

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 as a Python package is available from the command line.

Basic Usage

hookee makes it easy to get webhooks on the fly right from the console. Simply start it with:

hookee start

With its default configuration, this will start a server on port 8000, open a ngrok tunnel using hookee, and mount a URL at /webhook. Sending any request to the /webhook endpoint will dump the request and response data to the console.

hookee can be configured in a number of ways to quickly and easily tweak request and response data. For example, here we are customizing the response body from /webhook using the --response arg.

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

To see the ways hookee can be tweaked right from the console, view its documented args and commands like this:

hookee --help

Documentation

For more advanced usage, including how hookee's default configuration can be changed, extended through plugins, API integrations, and more, see its 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, sponsorship would also be greatly appreciated!

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

hookee-2.3.6.tar.gz (26.4 kB view details)

Uploaded Source

Built Distribution

hookee-2.3.6-py3-none-any.whl (25.1 kB view details)

Uploaded Python 3

File details

Details for the file hookee-2.3.6.tar.gz.

File metadata

  • Download URL: hookee-2.3.6.tar.gz
  • Upload date:
  • Size: 26.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.11.10

File hashes

Hashes for hookee-2.3.6.tar.gz
Algorithm Hash digest
SHA256 993801e4478d071c661e91b645f5d097e211f5ac140da1e58563575534329013
MD5 08846034e687cd4641de27889e4f4820
BLAKE2b-256 34ff1652b7022fd1ceb29ad73ead6839f7c4ee211cb7f68cc5d383d1f65a5734

See more details on using hashes here.

File details

Details for the file hookee-2.3.6-py3-none-any.whl.

File metadata

  • Download URL: hookee-2.3.6-py3-none-any.whl
  • Upload date:
  • Size: 25.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.11.10

File hashes

Hashes for hookee-2.3.6-py3-none-any.whl
Algorithm Hash digest
SHA256 af2a7bf68b64dfcb6d39dbe253744b8e2020b904bb8bc41023faf9d28ecafa70
MD5 55cb2f2459b78650a8038d2dc19ef3b9
BLAKE2b-256 8e17cd40f16d4959305dfba02e6470483c252b53b0783463c1bd2591090464c9

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page