%global _empty_manifest_terminate_build 0
Name: python-Flask-Shell2HTTP
Version: 1.9.1
Release: 1
Summary: A minimalist REST API wrapper for python's subprocess API.
License: BSD
URL: https://github.com/eshaan7/flask-shell2http
Source0: https://mirrors.nju.edu.cn/pypi/web/packages/58/46/7f7341c054f13ac6ba2bbebb75a71fba08438bc952cc442848a65d865d1a/Flask-Shell2HTTP-1.9.1.tar.gz
BuildArch: noarch
Requires: python3-flask
Requires: python3-blinker
Requires: python3-flask-executor
Requires: python3-flask
Requires: python3-blinker
Requires: python3-flask-executor
Requires: python3-flask-testing
Requires: python3-codecov
Requires: python3-tox
Requires: python3-tox-gh-actions
Requires: python3-black
Requires: python3-flake8
Requires: python3-pre-commit
%description
[](https://xscode.com/eshaan7/Flask-Shell2HTTP)
_For urgent issues and priority support, visit [https://xscode.com/eshaan7/flask-shell2http](https://xscode.com/eshaan7/flask-shell2http)._
# Flask-Shell2HTTP
[](https://pypi.org/project/Flask-Shell2HTTP/)
[](https://github.com/Eshaan7/flask-shell2http/actions?query=workflow%3A%22Linter+%26+Tests%22)
[](https://codecov.io/gh/Eshaan7/flask-shell2http/)
[](https://www.codefactor.io/repository/github/eshaan7/flask-shell2http)
A minimalist [Flask](https://github.com/pallets/flask) extension that serves as a RESTful/HTTP wrapper for python's subprocess API.
- **Convert any command-line tool into a REST API service.**
- Execute pre-defined shell commands asynchronously and securely via flask's endpoints with dynamic arguments, file upload, callback function capabilities.
- Designed for binary to binary/HTTP communication, development, prototyping, remote control and [more](https://flask-shell2http.readthedocs.io/en/stable/Examples.html).
## Use Cases
- Set a script that runs on a succesful POST request to an endpoint of your choice. See [Example code](examples/run_script.py).
- Map a base command to an endpoint and pass dynamic arguments to it. See [Example code](examples/basic.py).
- Can also process multiple uploaded files in one command. See [Example code](examples/multiple_files.py).
- 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/master/integrations/static_analyzers/app.py).
- You can define a callback function/ use signals to listen for process completion. See [Example code](examples/with_callback.py).
- Maybe want to pass some additional context to the callback function ?
- Maybe intercept on completion and update the result ? See [Example code](examples/custom_save_fn.py)
- You can also apply [View Decorators](https://flask.palletsprojects.com/en/1.1.x/patterns/viewdecorators/) to the exposed endpoint. See [Example code](examples/with_decorators.py).
> Note: This extension is primarily meant for executing long-running
> shell commands/scripts (like nmap, code-analysis' tools) in background from an HTTP request and getting the result at a later time.
## Documentation
[](https://flask-shell2http.readthedocs.io/en/latest/?badge=latest)
- Read the [Quickstart](https://flask-shell2http.readthedocs.io/en/stable/Quickstart.html) from the [documentation](https://flask-shell2http.readthedocs.io/) to get started!
- I also highly recommend the [Examples](https://flask-shell2http.readthedocs.io/en/stable/Examples.html) section.
- [CHANGELOG](https://github.com/eshaan7/Flask-Shell2HTTP/blob/master/.github/CHANGELOG.md).
## Quick Start
##### Dependencies
- Python: `>=v3.6`
- [Flask](https://pypi.org/project/Flask/)
- [Flask-Executor](https://pypi.org/project/Flask-Executor)
##### Installation
```bash
$ pip install flask flask_shell2http
```
##### Example Program
Create a file called `app.py`.
```python
from flask import Flask
from flask_executor import Executor
from flask_shell2http import Shell2HTTP
# Flask application instance
app = Flask(__name__)
executor = Executor(app)
shell2http = Shell2HTTP(app=app, executor=executor, base_url_prefix="/commands/")
def my_callback_fn(context, future):
# optional user-defined callback function
print(context, future.result())
shell2http.register_command(endpoint="saythis", command_name="echo", callback_fn=my_callback_fn, decorators=[])
```
Run the application server with, `$ flask run -p 4000`.
With <10 lines of code, we succesfully mapped the shell command `echo` to the endpoint `/commands/saythis`.
##### Making HTTP calls
This section demonstrates how we can now call/ execute commands over HTTP that we just mapped in the [example](#example-program) above.
```bash
$ curl -X POST -H 'Content-Type: application/json' -d '{"args": ["Hello", "World!"]}' http://localhost:4000/commands/saythis
```
or using python's requests module,
```python
# You can also add a timeout if you want, default value is 3600 seconds
data = {"args": ["Hello", "World!"], "timeout": 60}
resp = requests.post("http://localhost:4000/commands/saythis", json=data)
print("Result:", resp.json())
```
or using python's requests module,
```python
# You can also add a timeout if you want, default value is 3600 seconds
data = {"args": ["Hello", "World!"], "timeout": 60}
resp = requests.post("http://localhost:4000/commands/saythis", json=data)
print("Result:", resp.json())
```
or using python's requests module,
```python
# You can also add a timeout if you want, default value is 3600 seconds
data = {"args": ["Hello", "World!"], "timeout": 60}
resp = requests.post("http://localhost:4000/commands/saythis", json=data)
print("Result:", resp.json())
```