Skip to content

Commit 412cc9e

Browse files
committed
Update README.md
1 parent a7bb6c8 commit 412cc9e

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

README.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ A minimalist [Flask](https://github.com/pallets/flask) extension that serves as
1010

1111
- **Convert any command-line tool into a REST API service.**
1212
- Execute pre-defined shell commands asynchronously and securely via flask's endpoints.
13-
- Designed for development, prototyping or remote control.
13+
- Designed for binary to binary/HTTP communication, development, prototyping, remote control and [more](https://flask-shell2http.readthedocs.io/en/stable/Examples.html).
1414

1515
Inspired by the work of awesome folks over at [msoap/shell2http](https://github.com/msoap/shell2http).
1616

@@ -20,7 +20,8 @@ Inspired by the work of awesome folks over at [msoap/shell2http](https://github.
2020
- Map a base command to an endpoint and pass dynamic arguments to it. See [Example code](examples/basic.py).
2121
- Can also process multiple uploaded files in one command. See [Example code](examples/multiple_files.py).
2222
- This is useful for internal docker-to-docker communications if you have different binaries distributed in micro-containers. See [real-life example](https://github.com/intelowlproject/IntelOwl/blob/develop/integrations/peframe/app.py).
23-
- Currently, all commands are run asynchronously (default timeout is 3600 seconds), so result is not available directly. An option _may_ be provided for this in future release.
23+
- You can define a callback function/ use signals to listen for process completion. See [Example code](examples/with_callback.py). Meybe want to intercept on completion and update the result ? See [Example code](examples/custom_save_fn.py)
24+
- Currently, all commands run asynchronously (default timeout is 3600 seconds), so result is not available directly. An option _may_ be provided for this in future release.
2425

2526
> Note: This extension is primarily meant for executing long-running
2627
> shell commands/scripts (like nmap, code-analysis' tools) in background from an HTTP request and getting the result at a later time.
@@ -32,7 +33,9 @@ Inspired by the work of awesome folks over at [msoap/shell2http](https://github.
3233
Read the [Quickstart](https://flask-shell2http.readthedocs.io/en/stable/Quickstart.html)
3334
from the [documentation](https://flask-shell2http.readthedocs.io/) to get started!
3435

36+
I highly recommend the [Examples](https://flask-shell2http.readthedocs.io/en/stable/Examples.html) section.
37+
3538
## Why?
3639

37-
This was initially made to integrate various command-line tools easily with [IntelOwl](https://github.com/intelowlproject/IntelOwl).
40+
This was initially made to integrate various command-line tools easily with [Intel Owl](https://github.com/intelowlproject/IntelOwl), which I am working on as part of Google Summer of Code.
3841

0 commit comments

Comments
 (0)