| Name | hookee JSON |
| Version |
2.3.5
JSON |
| download |
| home_page | None |
| Summary | Command line webhooks, on demand. |
| upload_time | 2024-04-09 16:26:06 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | MIT License Copyright (c) 2020-2024 Alex Laird Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
|
| 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>
[](https://pypi.org/project/hookee)
[](https://pypi.org/project/hookee/)
[](https://codecov.io/gh/alexdlaird/hookee)
[](https://github.com/alexdlaird/hookee/actions/workflows/build.yml)
[](https://hookee.readthedocs.io/en/latest)
[](https://github.com/alexdlaird/hookee/blob/main/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](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 8000, open a [`ngrok`](https://ngrok.com/) tunnel
using [`hookee`](https://hookee.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/main/CONTRIBUTING.rst).
Want to contribute financially? If you've found `hookee` useful, [sponsorship](https://github.com/sponsors/alexdlaird) would
also be greatly appreciated!
Raw data
{
"_id": null,
"home_page": null,
"name": "hookee",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "Alex Laird <contact@alexlaird.com>",
"keywords": null,
"author": null,
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/46/fb/1d04955fc4cc6319d3ccdef58a559c23ca06a545211e7c3f968f6c2b56d5/hookee-2.3.5.tar.gz",
"platform": null,
"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[](https://pypi.org/project/hookee)\n[](https://pypi.org/project/hookee/)\n[](https://codecov.io/gh/alexdlaird/hookee)\n[](https://github.com/alexdlaird/hookee/actions/workflows/build.yml)\n[](https://hookee.readthedocs.io/en/latest)\n[](https://github.com/alexdlaird/hookee/blob/main/LICENSE)\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 8000, open a [`ngrok`](https://ngrok.com/) tunnel\nusing [`hookee`](https://hookee.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/main/CONTRIBUTING.rst).\n\nWant to contribute financially? If you've found `hookee` useful, [sponsorship](https://github.com/sponsors/alexdlaird) would\nalso be greatly appreciated!\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2020-2024 Alex Laird Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
"summary": "Command line webhooks, on demand.",
"version": "2.3.5",
"project_urls": {
"Changelog": "https://github.com/alexdlaird/hookee/blob/main/CHANGELOG.md",
"Documentation": "https://hookee.readthedocs.io",
"Source Code": "https://github.com/alexdlaird/hookee",
"Sponsor": "https://github.com/sponsors/alexdlaird"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "994cc28611f0873ec8200a6f697cd93b5512a7bc5a1fd9a45c1628a312c19b1e",
"md5": "7b27a7ee98b1adccd1445a25b0fb65f5",
"sha256": "1f25c84d2efa7f23fec04439b0041b8204b3e110d26801ae7a678626ac68e831"
},
"downloads": -1,
"filename": "hookee-2.3.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7b27a7ee98b1adccd1445a25b0fb65f5",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 24806,
"upload_time": "2024-04-09T16:26:04",
"upload_time_iso_8601": "2024-04-09T16:26:04.906519Z",
"url": "https://files.pythonhosted.org/packages/99/4c/c28611f0873ec8200a6f697cd93b5512a7bc5a1fd9a45c1628a312c19b1e/hookee-2.3.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "46fb1d04955fc4cc6319d3ccdef58a559c23ca06a545211e7c3f968f6c2b56d5",
"md5": "77d9640d801b8bd095bea5bff7d8847f",
"sha256": "d85ac391dafa7b01f7d1c535ed59cc3786e84695bba06190f2824badfaed018a"
},
"downloads": -1,
"filename": "hookee-2.3.5.tar.gz",
"has_sig": false,
"md5_digest": "77d9640d801b8bd095bea5bff7d8847f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 26004,
"upload_time": "2024-04-09T16:26:06",
"upload_time_iso_8601": "2024-04-09T16:26:06.281684Z",
"url": "https://files.pythonhosted.org/packages/46/fb/1d04955fc4cc6319d3ccdef58a559c23ca06a545211e7c3f968f6c2b56d5/hookee-2.3.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-09 16:26:06",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "alexdlaird",
"github_project": "hookee",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "hookee"
}
