Metadata-Version: 2.1
Name: hookee
Version: 0.0.8
Summary: Command line webhooks, on demand.
Home-page: https://github.com/alexdlaird/hookee
Author: Alex Laird
Author-email: contact@alexlaird.com
License: MIT
Download-URL: https://github.com/alexdlaird/hookee/archive/0.0.8.tar.gz
Project-URL: Sponsor, https://www.paypal.me/alexdlaird
Project-URL: Changelog, https://github.com/alexdlaird/hookee/blob/master/CHANGELOG.md
Description: # hookee - command line webhooks, on demand
        
        [![PyPI version](https://badge.fury.io/py/hookee.svg)](https://badge.fury.io/py/hookee)
        [![Build Status](https://travis-ci.org/alexdlaird/hookee.svg?branch=master)](https://travis-ci.org/alexdlaird/hookee)
        [![codecov](https://codecov.io/gh/alexdlaird/hookee/branch/master/graph/badge.svg)](https://codecov.io/gh/alexdlaird/hookee)
        [![Documentation Status](https://readthedocs.org/projects/hookee/badge/?version=latest)](https://hookee.readthedocs.io/en/latest/?badge=latest)
        [![PyPI license](https://img.shields.io/pypi/l/hookee.svg)](https://pypi.org/project/hookee/)
        
        `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](https://pypi.org/project/hookee/) and can be installed
        using `pip`:
        
        ```sh
        pip install hookee
        ```
        
        or `conda`:
        
        ```sh
        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.
        
        ```sh
        hookee start
        ```
        
        This will start a server on the default port 5000, open a [`ngrok`](https://ngrok.com/) tunnel to this server
        using [`pyngrok`](https://pyngrok.readthedocs.io/en/latest/), 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.
        
        ```sh
        hookee start --response "<?xml version=\"1.0\" encoding=\"UTF-8\"?><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](http://hookee.readthedocs.io).
        
        ## Contributing
        
        If you would like to get involved, be sure to review the [Contribution Guide](https://github.com/alexdlaird/hookee/blob/master/CONTRIBUTING.rst).
        
        Want to contribute financially? If you've found `hookee` useful, [a donation](https://www.paypal.me/alexdlaird>) would
        also be greatly appreciated!
        
Keywords: python,webhook,ngrok,flask
Platform: UNKNOWN
Classifier: Environment :: Console
Classifier: Environment :: Web Environment
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Education
Classifier: Intended Audience :: Information Technology
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: MacOS
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX
Classifier: Operating System :: POSIX :: BSD :: FreeBSD
Classifier: Operating System :: POSIX :: Linux
Classifier: Operating System :: Unix
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Topic :: Internet
Classifier: Topic :: Internet :: Proxy Servers
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Internet :: WWW/HTTP :: HTTP Servers
Classifier: Topic :: Software Development :: Testing
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*
Description-Content-Type: text/markdown
