hookee


Namehookee JSON
Version 1.2.2 PyPI version JSON
download
home_pagehttps://github.com/alexdlaird/hookee
SummaryCommand line webhooks, on demand.
upload_time2020-09-20 22:19:41
maintainer
docs_urlNone
authorAlex Laird
requires_python>=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*
licenseMIT
keywords python webhook ngrok flask
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            <p align="center"><img alt="hookee - command line webhooks, on demand" src="https://hookee.readthedocs.io/en/latest/_images/logo.png" /></p>

[![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/)
[![Tweet](https://img.shields.io/twitter/url/http/shields.io.svg?style=social)](https://twitter.com/intent/tweet?text=Check+out+%23hookee%2C+a+utility+that+provides+command+line+%23webhooks%2C+on+demand.%0D%0A%0D%0A&url=https://github.com/alexdlaird/hookee&via=alexdlaird&hashtags=python,flask,ngrok,pyngrok)

`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 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:

```sh
hookee start
```

With its default configuration, this will start a server on port 5000, open a [`ngrok`](https://ngrok.com/) tunnel
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 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.

```sh
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:

```sh
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](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!
            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/alexdlaird/hookee",
    "name": "hookee",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*",
    "maintainer_email": "",
    "keywords": "python,webhook,ngrok,flask",
    "author": "Alex Laird",
    "author_email": "contact@alexlaird.com",
    "download_url": "https://files.pythonhosted.org/packages/ab/2f/b7983935a0ed120401966e9a556a4a89cdbae2ba40e6b78a7b1658400eee/hookee-1.2.2.tar.gz",
    "platform": "",
    "description": "<p align=\"center\"><img alt=\"hookee - command line webhooks, on demand\" src=\"https://hookee.readthedocs.io/en/latest/_images/logo.png\" /></p>\n\n[![PyPI version](https://badge.fury.io/py/hookee.svg)](https://badge.fury.io/py/hookee)\n[![Build Status](https://travis-ci.org/alexdlaird/hookee.svg?branch=master)](https://travis-ci.org/alexdlaird/hookee)\n[![codecov](https://codecov.io/gh/alexdlaird/hookee/branch/master/graph/badge.svg)](https://codecov.io/gh/alexdlaird/hookee)\n[![Documentation Status](https://readthedocs.org/projects/hookee/badge/?version=latest)](https://hookee.readthedocs.io/en/latest/?badge=latest)\n[![PyPI license](https://img.shields.io/pypi/l/hookee.svg)](https://pypi.org/project/hookee/)\n[![Tweet](https://img.shields.io/twitter/url/http/shields.io.svg?style=social)](https://twitter.com/intent/tweet?text=Check+out+%23hookee%2C+a+utility+that+provides+command+line+%23webhooks%2C+on+demand.%0D%0A%0D%0A&url=https://github.com/alexdlaird/hookee&via=alexdlaird&hashtags=python,flask,ngrok,pyngrok)\n\n`hookee` is a utility that provides command line webhooks, on demand! Dump useful request data to the\nconsole, process requests and responses, customize response data, and configure `hookee` and its routes\nfurther in any number of ways through custom plugins.\n\n## Installation\n\n`hookee` is available on [PyPI](https://pypi.org/project/hookee/) and can be installed\nusing `pip`:\n\n```sh\npip install hookee\n```\n\nor `conda`:\n\n```sh\nconda install -c conda-forge hookee\n```\n\nThat's it! `hookee` is now available as a Python package is available from the command line.\n\n## Basic Usage\n\n`hookee` makes it easy to get webhooks on the fly right from the console. Simply start it with:\n\n```sh\nhookee start\n```\n\nWith its default configuration, this will start a server on port 5000, open a [`ngrok`](https://ngrok.com/) tunnel\nusing [`pyngrok`](https://pyngrok.readthedocs.io/en/latest/), and mount a URL at `/webhook`. Sending any request to\nthe `/webhook` endpoint will dump the request and response data to the console.\n\n`hookee` can be configured in a number of ways to quickly and easily tweak request and response data. For example,\nhere we are customizing the response body from `/webhook` using the `--response` arg.\n\n```sh\nhookee --response \"<Response>Ok</Response>\" --content-type application/xml\n```\n\nTo see the ways `hookee` can be tweaked right from the console, view its documented args and commands like this:\n\n```sh\nhookee --help\n```\n\n## Documentation\n\nFor more advanced usage, including how `hookee`'s default configuration can be changed, extended through plugins,\nAPI integrations, and more, see its official documentation is available at [http://hookee.readthedocs.io](http://hookee.readthedocs.io).\n\n## Contributing\n\nIf you would like to get involved, be sure to review the [Contribution Guide](https://github.com/alexdlaird/hookee/blob/master/CONTRIBUTING.rst).\n\nWant to contribute financially? If you've found `hookee` useful, [a donation](https://www.paypal.me/alexdlaird>) would\nalso be greatly appreciated!",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Command line webhooks, on demand.",
    "version": "1.2.2",
    "split_keywords": [
        "python",
        "webhook",
        "ngrok",
        "flask"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "a32f8f50b49fce78f95f7b3d8f501150",
                "sha256": "9718515fa2731b46aa26f9e1f1f517d1f8fc647cd2e884370b651ce4d0b8abbb"
            },
            "downloads": -1,
            "filename": "hookee-1.2.2.tar.gz",
            "has_sig": false,
            "md5_digest": "a32f8f50b49fce78f95f7b3d8f501150",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*",
            "size": 18838,
            "upload_time": "2020-09-20T22:19:41",
            "upload_time_iso_8601": "2020-09-20T22:19:41.933071Z",
            "url": "https://files.pythonhosted.org/packages/ab/2f/b7983935a0ed120401966e9a556a4a89cdbae2ba40e6b78a7b1658400eee/hookee-1.2.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2020-09-20 22:19:41",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "github_user": null,
    "github_project": "alexdlaird",
    "error": "Could not fetch GitHub repository",
    "lcname": "hookee"
}
        
Elapsed time: 0.17222s