flask-stream 1.0.0__tar.gz

flask_stream-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Parkteknia and P3r4nD
+
+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.

flask_stream-1.0.0/PKG-INFO

@@ -0,0 +1,146 @@
+Metadata-Version: 2.4
+Name: flask-stream
+Version: 1.0.0
+Summary: Flask extension for remote downloads and progress streaming
+Author-email: Pera Andreu <perapublica@gmail.com>
+License: MIT License
+        
+        Copyright (c) 2026 Parkteknia and P3r4nD
+        
+        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.
+        
+Project-URL: Homepage, https://github.com/P3r4nD/flask-stream
+Classifier: Framework :: Flask
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: Flask>=3.1.3
+Requires-Dist: paramiko>=4.0
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0; extra == "dev"
+Requires-Dist: black; extra == "dev"
+Requires-Dist: isort; extra == "dev"
+Dynamic: license-file
+
+# Flask-Stream
+
+[![PyPI](https://img.shields.io/pypi/v/flask-stream)](https://pypi.org/project/flask-stream/)
+[![Python Version](https://img.shields.io/badge/python-3.11%2B-blue)](https://www.python.org/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
+![CI](https://github.com/P3r4nD/flask-stream/actions/workflows/python-publish.yml/badge.svg?branch=main)
+
+**Flask-Stream** is a Flask 3 extension that enables real-time streaming of file downloads from one or multiple remote servers directly in your web application's UI. It is designed to be easy to integrate, flexible, and extensible for future types of streams.
+
+---
+
+## Features
+
+1. **SSH File Downloads**
+   - Connect to remote servers via SSH key authentication.
+   - Recursive file listing on remote servers.
+   - Real-time file download progress updates.
+
+2. **Multiple Servers Support**
+   - Configure one or multiple servers in the Flask app.
+   - Each server can have its own `remote_base` and download folder.
+   - The UI clearly differentiates which server each file comes from.
+
+3. **Smart Progress Bars**
+   - **Individual file progress:** shows percentage and downloaded size (MB).
+   - **Total progress:** tracks the progress over all files in the job.
+   - For multiple simultaneous downloads, each active file has its own progress bar and filename.
+
+4. **Parallel Downloads (Optional)**
+   - Controlled via `STREAM_BULK_DOWNLOAD` and `STREAM_MAX_SIMULTANEOUS`.
+   - Downloads multiple files at once respecting the concurrency limit.
+   - Useful for large datasets or multiple servers.
+
+5. **Ready-to-use HTML/JavaScript UI**
+   - Includable download button via `{{ stream_button() }}`.
+   - Shows logs, errors, and dynamic progress using Server-Sent Events (SSE).
+   - Fully compatible with Bootstrap 5 for responsive styling.
+
+6. **Extensible Architecture**
+   - Implements a `StreamProvider` base, enabling future stream types (HTTP, FTP, S3, etc.).
+   - Supports `init_app()` pattern for multiple Flask apps in the same process.
+
+7. **Asynchronous Job Management**
+   - Each download job runs in a separate thread.
+   - Event queues per job enable real-time UI updates and multiple concurrent jobs.
+
+8. **Error Handling**
+   - Stream errors reported in UI.
+   - Disconnects from server or app are shown as "Server or App disconnected".
+
+9. **Centralized Configuration**
+   - Configure all parameters via `app.config` or a central config file.
+   - Main configuration variables:
+     ```python
+     STREAM_PROVIDER          # Currently "ssh"
+     STREAM_SERVERS           # List of servers with host, user, key, remote_base, name
+     STREAM_DOWNLOAD_DIR      # Local download directory
+     STREAM_BULK_DOWNLOAD     # Enable parallel downloads
+     STREAM_MAX_SIMULTANEOUS  # Max simultaneous downloads
+     ```
+
+10. **Integrated Tests**
+    - Unit tests with **pytest** covering routes, events, and basic functionality.
+    - Installable in editable mode with `pip install -e .[dev]`.
+
+---
+
+## Installation
+
+```bash
+# Clone repository
+git clone https://github.com/yourusername/flask-stream.git
+cd flask-stream
+
+# Install with dev dependencies
+pip install -e .[dev]
+
+## Basic usage
+```python
+from flask import Flask
+from flask_stream import Stream
+
+app = Flask(__name__)
+app.config.update({
+    "STREAM_SERVERS": [
+        {"name": "server1", "host": "example.com", "user": "ubuntu", "key": "~/.ssh/id_rsa", "remote_base": "logs"},
+        {"name": "server2", "host": "example2.com", "user": "ubuntu", "key": "~/.ssh/id_rsa", "remote_base": "logs"}
+    ],
+    "STREAM_DOWNLOAD_DIR": "downloads",
+    "STREAM_BULK_DOWNLOAD": True,
+    "STREAM_MAX_SIMULTANEOUS": 2
+})
+
+stream = Stream(app)
+
+@app.route("/")
+def index():
+    return """
+    <h3>Download Logs</h3>
+    {{ stream_button() }}
+    """
+```
+

flask_stream-1.0.0/README.md

@@ -0,0 +1,103 @@
+# Flask-Stream
+
+[![PyPI](https://img.shields.io/pypi/v/flask-stream)](https://pypi.org/project/flask-stream/)
+[![Python Version](https://img.shields.io/badge/python-3.11%2B-blue)](https://www.python.org/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
+![CI](https://github.com/P3r4nD/flask-stream/actions/workflows/python-publish.yml/badge.svg?branch=main)
+
+**Flask-Stream** is a Flask 3 extension that enables real-time streaming of file downloads from one or multiple remote servers directly in your web application's UI. It is designed to be easy to integrate, flexible, and extensible for future types of streams.
+
+---
+
+## Features
+
+1. **SSH File Downloads**
+   - Connect to remote servers via SSH key authentication.
+   - Recursive file listing on remote servers.
+   - Real-time file download progress updates.
+
+2. **Multiple Servers Support**
+   - Configure one or multiple servers in the Flask app.
+   - Each server can have its own `remote_base` and download folder.
+   - The UI clearly differentiates which server each file comes from.
+
+3. **Smart Progress Bars**
+   - **Individual file progress:** shows percentage and downloaded size (MB).
+   - **Total progress:** tracks the progress over all files in the job.
+   - For multiple simultaneous downloads, each active file has its own progress bar and filename.
+
+4. **Parallel Downloads (Optional)**
+   - Controlled via `STREAM_BULK_DOWNLOAD` and `STREAM_MAX_SIMULTANEOUS`.
+   - Downloads multiple files at once respecting the concurrency limit.
+   - Useful for large datasets or multiple servers.
+
+5. **Ready-to-use HTML/JavaScript UI**
+   - Includable download button via `{{ stream_button() }}`.
+   - Shows logs, errors, and dynamic progress using Server-Sent Events (SSE).
+   - Fully compatible with Bootstrap 5 for responsive styling.
+
+6. **Extensible Architecture**
+   - Implements a `StreamProvider` base, enabling future stream types (HTTP, FTP, S3, etc.).
+   - Supports `init_app()` pattern for multiple Flask apps in the same process.
+
+7. **Asynchronous Job Management**
+   - Each download job runs in a separate thread.
+   - Event queues per job enable real-time UI updates and multiple concurrent jobs.
+
+8. **Error Handling**
+   - Stream errors reported in UI.
+   - Disconnects from server or app are shown as "Server or App disconnected".
+
+9. **Centralized Configuration**
+   - Configure all parameters via `app.config` or a central config file.
+   - Main configuration variables:
+     ```python
+     STREAM_PROVIDER          # Currently "ssh"
+     STREAM_SERVERS           # List of servers with host, user, key, remote_base, name
+     STREAM_DOWNLOAD_DIR      # Local download directory
+     STREAM_BULK_DOWNLOAD     # Enable parallel downloads
+     STREAM_MAX_SIMULTANEOUS  # Max simultaneous downloads
+     ```
+
+10. **Integrated Tests**
+    - Unit tests with **pytest** covering routes, events, and basic functionality.
+    - Installable in editable mode with `pip install -e .[dev]`.
+
+---
+
+## Installation
+
+```bash
+# Clone repository
+git clone https://github.com/yourusername/flask-stream.git
+cd flask-stream
+
+# Install with dev dependencies
+pip install -e .[dev]
+
+## Basic usage
+```python
+from flask import Flask
+from flask_stream import Stream
+
+app = Flask(__name__)
+app.config.update({
+    "STREAM_SERVERS": [
+        {"name": "server1", "host": "example.com", "user": "ubuntu", "key": "~/.ssh/id_rsa", "remote_base": "logs"},
+        {"name": "server2", "host": "example2.com", "user": "ubuntu", "key": "~/.ssh/id_rsa", "remote_base": "logs"}
+    ],
+    "STREAM_DOWNLOAD_DIR": "downloads",
+    "STREAM_BULK_DOWNLOAD": True,
+    "STREAM_MAX_SIMULTANEOUS": 2
+})
+
+stream = Stream(app)
+
+@app.route("/")
+def index():
+    return """
+    <h3>Download Logs</h3>
+    {{ stream_button() }}
+    """
+```
+

flask_stream-1.0.0/flask_stream/__init__.py

@@ -0,0 +1,3 @@
+from .extension import Stream
+
+__all__ = ["Stream"]

flask_stream-1.0.0/flask_stream/blueprint.py

@@ -0,0 +1,43 @@
+from flask import Blueprint, Response, current_app, jsonify
+import json
+import threading
+from .jobs import create_job, jobs
+
+bp = Blueprint(
+    "stream",
+    __name__,
+    url_prefix="/stream",
+    template_folder="templates",
+    static_folder="static"
+)
+
+
+@bp.route("/start", methods=["POST"])
+def start():
+    job_id = create_job()
+
+    provider_name = current_app.config["STREAM_PROVIDER"]
+    # use the app.extensions manager
+    provider = current_app.extensions["stream"].manager.get(provider_name)
+
+    thread = threading.Thread(
+        target=provider.run,
+        args=(current_app._get_current_object(), job_id),
+        daemon=True
+    )
+    thread.start()
+
+    return jsonify({"job_id": job_id})
+
+
+@bp.route("/events/<job_id>")
+def events(job_id):
+    def generator():
+        q = jobs[job_id]["queue"]
+        while True:
+            item = q.get()
+            yield f"event: {item['event']}\n"
+            yield f"data: {json.dumps(item['data'])}\n\n"
+            if jobs[job_id]["done"] and q.empty():
+                break
+    return Response(generator(), mimetype="text/event-stream")

flask_stream-1.0.0/flask_stream/config.py

@@ -0,0 +1,10 @@
+class DefaultConfig:
+
+    STREAM_PROVIDER = "ssh"
+
+    STREAM_DOWNLOAD_DIR = "downloads"
+
+    STREAM_BULK_DOWNLOAD = True
+    STREAM_MAX_SIMULTANEOUS = 4
+
+    STREAM_SERVERS = []

flask_stream-1.0.0/flask_stream/extension.py

@@ -0,0 +1,35 @@
+from flask import render_template
+from markupsafe import Markup
+from .config import DefaultConfig
+from .manager import StreamManager
+from .blueprint import bp
+
+class Stream:
+
+    def __init__(self, app=None):
+
+        self.manager = StreamManager()
+
+        if app:
+            self.init_app(app)
+
+    def init_app(self, app):
+
+        for k, v in DefaultConfig.__dict__.items():
+            if k.isupper():
+                app.config.setdefault(k, v)
+
+        app.extensions["stream"] = self
+
+        app.register_blueprint(bp)
+
+        app.context_processor(lambda: {
+            "stream_button": self.button,
+            "stream_config": {
+                "bulk": app.config["STREAM_BULK_DOWNLOAD"],
+                "max_simultaneous": app.config["STREAM_MAX_SIMULTANEOUS"]
+            }
+        })
+
+    def button(self):
+        return Markup(render_template("stream_button.html"))

flask_stream-1.0.0/flask_stream/jobs.py

@@ -0,0 +1,26 @@
+import uuid
+from queue import Queue
+
+jobs = {}
+
+def create_job():
+
+    job_id = str(uuid.uuid4())
+
+    jobs[job_id] = {
+        "queue": Queue(),
+        "done": False
+    }
+
+    return job_id
+
+def push_event(job_id, event, data):
+
+    jobs[job_id]["queue"].put({
+        "event": event,
+        "data": data
+    })
+
+def finish_job(job_id):
+
+    jobs[job_id]["done"] = True

flask_stream-1.0.0/flask_stream/manager.py

@@ -0,0 +1,13 @@
+class StreamManager:
+
+    def __init__(self):
+
+        from .providers.ssh_download import SSHDownloadProvider
+
+        self.providers = {
+            "ssh": SSHDownloadProvider()
+        }
+
+    def get(self, name):
+
+        return self.providers[name]

flask_stream-1.0.0/flask_stream/providers/base.py

@@ -0,0 +1,4 @@
+class StreamProvider:
+
+    def run(self, app, job_id):
+        raise NotImplementedError

flask_stream-1.0.0/flask_stream/providers/ssh_download.py

@@ -0,0 +1,147 @@
+import os
+import stat
+import paramiko
+from concurrent.futures import ThreadPoolExecutor
+
+from ..jobs import push_event, finish_job
+
+
+class SSHDownloadProvider:
+
+    def connect(self, server):
+
+        client = paramiko.SSHClient()
+        client.set_missing_host_key_policy(paramiko.AutoAddPolicy())
+
+        client.connect(
+            server["host"],
+            port=server.get("port", 22),
+            username=server["user"],
+            key_filename=os.path.expanduser(server["key"])
+        )
+
+        return client
+
+    def is_dir(self, entry):
+        return stat.S_ISDIR(entry.st_mode)
+
+    def list_recursive(self, sftp, base):
+
+        files = []
+
+        def walk(path, prefix=""):
+
+            for entry in sftp.listdir_attr(path):
+
+                name = entry.filename
+
+                if name in (".", ".."):
+                    continue
+
+                full = f"{path}/{name}"
+                rel = f"{prefix}{name}"
+
+                if self.is_dir(entry):
+                    walk(full, rel + "/")
+                else:
+                    files.append(rel)
+
+        walk(base)
+
+        return files
+
+    def run(self, app, job_id):
+
+        download_dir = app.config["STREAM_DOWNLOAD_DIR"]
+        servers = app.config["STREAM_SERVERS"]
+        bulk = app.config.get("STREAM_BULK_DOWNLOAD", False)
+        max_sim = app.config.get("STREAM_MAX_SIMULTANEOUS", 2)
+
+        for server in servers:
+
+            push_event(job_id, "debug", {
+                "msg": f"Connecting {server['name']}",
+                "server": server["name"]
+            })
+
+            base = server["remote_base"]
+
+            # Creamos un client temporal solo para listar archivos
+            client_list = self.connect(server)
+            sftp_list = client_list.open_sftp()
+            files = self.list_recursive(sftp_list, base)
+            sftp_list.close()
+            client_list.close()
+
+            total_files = len(files)
+
+            push_event(job_id, "Batch", {
+                "server": server["name"],
+                "total": total_files
+            })
+
+            push_event(job_id, "debug", {
+                "msg": f"{len(files)} files found",
+                "server": server["name"]
+            })
+
+            def download_file(rel):
+
+                # Each worker creates their own connection
+                client = self.connect(server)
+                sftp = client.open_sftp()
+
+                try:
+
+                    remote_path = f"{base}/{rel}"
+                    local_path = os.path.join(download_dir, server["name"], rel)
+
+                    statinfo = sftp.stat(remote_path)
+                    size = statinfo.st_size
+
+                    push_event(job_id, "File", {
+                        "file": rel,
+                        "size": size,
+                        "server": server["name"]
+                    })
+
+                    os.makedirs(os.path.dirname(local_path), exist_ok=True)
+
+                    with sftp.open(remote_path, "rb") as remote_file, open(local_path, "wb") as f:
+
+                        downloaded = 0
+                        chunk = 32768
+
+                        while True:
+                            data = remote_file.read(chunk)
+                            if not data:
+                                break
+                            f.write(data)
+                            downloaded += len(data)
+                            percent = int(downloaded / size * 100)
+                            push_event(job_id, "Progress", {
+                                "percent": percent,
+                                "file": rel,
+                                "server": server["name"]
+                            })
+
+                    push_event(job_id, "FileDone", {
+                        "file": rel,
+                        "server": server["name"]
+                    })
+
+                finally:
+                    sftp.close()
+                    client.close()
+
+            # Bulk: parallel downloads
+            if bulk:
+                with ThreadPoolExecutor(max_workers=max_sim) as executor:
+                    executor.map(download_file, files)
+            else:
+                # Sequential
+                for f in files:
+                    download_file(f)
+
+        push_event(job_id, "done", {})
+        finish_job(job_id)

flask_stream-1.0.0/flask_stream.egg-info/PKG-INFO

@@ -0,0 +1,146 @@
+Metadata-Version: 2.4
+Name: flask-stream
+Version: 1.0.0
+Summary: Flask extension for remote downloads and progress streaming
+Author-email: Pera Andreu <perapublica@gmail.com>
+License: MIT License
+        
+        Copyright (c) 2026 Parkteknia and P3r4nD
+        
+        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.
+        
+Project-URL: Homepage, https://github.com/P3r4nD/flask-stream
+Classifier: Framework :: Flask
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: Flask>=3.1.3
+Requires-Dist: paramiko>=4.0
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0; extra == "dev"
+Requires-Dist: black; extra == "dev"
+Requires-Dist: isort; extra == "dev"
+Dynamic: license-file
+
+# Flask-Stream
+
+[![PyPI](https://img.shields.io/pypi/v/flask-stream)](https://pypi.org/project/flask-stream/)
+[![Python Version](https://img.shields.io/badge/python-3.11%2B-blue)](https://www.python.org/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
+![CI](https://github.com/P3r4nD/flask-stream/actions/workflows/python-publish.yml/badge.svg?branch=main)
+
+**Flask-Stream** is a Flask 3 extension that enables real-time streaming of file downloads from one or multiple remote servers directly in your web application's UI. It is designed to be easy to integrate, flexible, and extensible for future types of streams.
+
+---
+
+## Features
+
+1. **SSH File Downloads**
+   - Connect to remote servers via SSH key authentication.
+   - Recursive file listing on remote servers.
+   - Real-time file download progress updates.
+
+2. **Multiple Servers Support**
+   - Configure one or multiple servers in the Flask app.
+   - Each server can have its own `remote_base` and download folder.
+   - The UI clearly differentiates which server each file comes from.
+
+3. **Smart Progress Bars**
+   - **Individual file progress:** shows percentage and downloaded size (MB).
+   - **Total progress:** tracks the progress over all files in the job.
+   - For multiple simultaneous downloads, each active file has its own progress bar and filename.
+
+4. **Parallel Downloads (Optional)**
+   - Controlled via `STREAM_BULK_DOWNLOAD` and `STREAM_MAX_SIMULTANEOUS`.
+   - Downloads multiple files at once respecting the concurrency limit.
+   - Useful for large datasets or multiple servers.
+
+5. **Ready-to-use HTML/JavaScript UI**
+   - Includable download button via `{{ stream_button() }}`.
+   - Shows logs, errors, and dynamic progress using Server-Sent Events (SSE).
+   - Fully compatible with Bootstrap 5 for responsive styling.
+
+6. **Extensible Architecture**
+   - Implements a `StreamProvider` base, enabling future stream types (HTTP, FTP, S3, etc.).
+   - Supports `init_app()` pattern for multiple Flask apps in the same process.
+
+7. **Asynchronous Job Management**
+   - Each download job runs in a separate thread.
+   - Event queues per job enable real-time UI updates and multiple concurrent jobs.
+
+8. **Error Handling**
+   - Stream errors reported in UI.
+   - Disconnects from server or app are shown as "Server or App disconnected".
+
+9. **Centralized Configuration**
+   - Configure all parameters via `app.config` or a central config file.
+   - Main configuration variables:
+     ```python
+     STREAM_PROVIDER          # Currently "ssh"
+     STREAM_SERVERS           # List of servers with host, user, key, remote_base, name
+     STREAM_DOWNLOAD_DIR      # Local download directory
+     STREAM_BULK_DOWNLOAD     # Enable parallel downloads
+     STREAM_MAX_SIMULTANEOUS  # Max simultaneous downloads
+     ```
+
+10. **Integrated Tests**
+    - Unit tests with **pytest** covering routes, events, and basic functionality.
+    - Installable in editable mode with `pip install -e .[dev]`.
+
+---
+
+## Installation
+
+```bash
+# Clone repository
+git clone https://github.com/yourusername/flask-stream.git
+cd flask-stream
+
+# Install with dev dependencies
+pip install -e .[dev]
+
+## Basic usage
+```python
+from flask import Flask
+from flask_stream import Stream
+
+app = Flask(__name__)
+app.config.update({
+    "STREAM_SERVERS": [
+        {"name": "server1", "host": "example.com", "user": "ubuntu", "key": "~/.ssh/id_rsa", "remote_base": "logs"},
+        {"name": "server2", "host": "example2.com", "user": "ubuntu", "key": "~/.ssh/id_rsa", "remote_base": "logs"}
+    ],
+    "STREAM_DOWNLOAD_DIR": "downloads",
+    "STREAM_BULK_DOWNLOAD": True,
+    "STREAM_MAX_SIMULTANEOUS": 2
+})
+
+stream = Stream(app)
+
+@app.route("/")
+def index():
+    return """
+    <h3>Download Logs</h3>
+    {{ stream_button() }}
+    """
+```
+

flask_stream-1.0.0/flask_stream.egg-info/SOURCES.txt

@@ -0,0 +1,19 @@
+LICENSE
+README.md
+pyproject.toml
+flask_stream/__init__.py
+flask_stream/blueprint.py
+flask_stream/config.py
+flask_stream/extension.py
+flask_stream/jobs.py
+flask_stream/manager.py
+flask_stream.egg-info/PKG-INFO
+flask_stream.egg-info/SOURCES.txt
+flask_stream.egg-info/dependency_links.txt
+flask_stream.egg-info/requires.txt
+flask_stream.egg-info/top_level.txt
+flask_stream/providers/__init__.py
+flask_stream/providers/base.py
+flask_stream/providers/ssh_download.py
+tests/test_basic.py
+tests/test_routes.py

flask_stream-1.0.0/flask_stream.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

flask_stream-1.0.0/flask_stream.egg-info/requires.txt

@@ -0,0 +1,7 @@
+Flask>=3.1.3
+paramiko>=4.0
+
+[dev]
+pytest>=7.0
+black
+isort

flask_stream-1.0.0/flask_stream.egg-info/top_level.txt

@@ -0,0 +1 @@
+flask_stream

flask_stream-1.0.0/pyproject.toml

@@ -0,0 +1,33 @@
+[build-system]
+requires = ["setuptools>=66", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "flask-stream"
+version = "1.0.0"
+description = "Flask extension for remote downloads and progress streaming"
+readme = "README.md"
+requires-python = ">=3.11"
+license = {file = "LICENSE"}
+authors = [
+    {name = "Pera Andreu", email = "perapublica@gmail.com"}
+]
+urls = { "Homepage" = "https://github.com/P3r4nD/flask-stream" }
+classifiers = [
+    "Framework :: Flask",
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+]
+
+dependencies = [
+    "Flask>=3.1.3",
+    "paramiko>=4.0",
+]
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=7.0",
+    "black",
+    "isort"
+]

flask_stream-1.0.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

flask_stream-1.0.0/tests/test_basic.py

@@ -0,0 +1,42 @@
+from flask import Flask
+from flask_stream import Stream
+
+
+def test_init_app():
+
+    app = Flask(__name__)
+
+    stream = Stream()
+    stream.init_app(app)
+
+    # the extension is registered
+    assert "stream" in app.extensions
+
+
+def test_blueprint_registered():
+
+    app = Flask(__name__)
+    Stream(app)
+
+    assert "stream" in app.blueprints
+
+
+def test_stream_button_context():
+
+    app = Flask(__name__)
+    Stream(app)
+
+    with app.app_context():
+
+        # the context processor should expose stream_button
+        ctx = app.template_context_processors[None]
+
+        found = False
+
+        for processor in ctx:
+            result = processor()
+            if "stream_button" in result:
+                found = True
+                break
+
+        assert found

flask_stream-1.0.0/tests/test_routes.py

@@ -0,0 +1,75 @@
+# tests/test_routes.py
+import time
+import json
+import pytest
+from flask import Flask
+from flask_stream import Stream
+from flask_stream.jobs import jobs
+
+# ---------- Dummy provider for testing ----------
+class DummyProvider:
+    """Simulate downloads without SSHing"""
+    def run(self, app, job_id):
+        # We simulated 3 files of different sizes.
+        files = [
+            {"file": "file1.txt", "size": 1000, "server": "dummy1"},
+            {"file": "file2.txt", "size": 2000, "server": "dummy1"},
+            {"file": "file3.txt", "size": 1500, "server": "dummy1"},
+        ]
+
+        # sent the Batch event
+        app.logger.debug("DummyProvider: starting run")
+        from flask_stream.jobs import push_event, finish_job
+        push_event(job_id, "Batch", {"server": "dummy1", "total": len(files)})
+
+        for f in files:
+            push_event(job_id, "File", f)
+            # simulate progress
+            for p in range(0, 101, 25):
+                push_event(job_id, "Progress", {"percent": p, **f})
+            push_event(job_id, "FileDone", f)
+
+        push_event(job_id, "done", {})
+        finish_job(job_id)
+
+
+# ---------- Fixture for the app ----------
+@pytest.fixture
+def app():
+    app = Flask(__name__)
+    stream_ext = Stream(app)
+
+    # We registered DummyProvider in the app manager
+    stream_ext.manager.providers["dummy"] = DummyProvider()
+    app.config["STREAM_PROVIDER"] = "dummy"
+
+    yield app
+
+
+# ---------- Test /stream/start ----------
+def test_start_route(app):
+    client = app.test_client()
+    r = client.post("/stream/start")
+    assert r.status_code == 200
+    data = r.get_json()
+    assert "job_id" in data
+    job_id = data["job_id"]
+    assert job_id in jobs
+
+
+# ---------- Test /stream/events/<job_id> ----------
+def test_events_stream(app):
+    client = app.test_client()
+    r = client.post("/stream/start")
+    job_id = r.get_json()["job_id"]
+
+    # consume the event stream
+    r2 = client.get(f"/stream/events/{job_id}", buffered=True)
+    assert r2.status_code == 200
+    data = r2.data.decode("utf-8")
+
+    # verify that some Dummy events were received
+    assert "event: File" in data
+    assert "event: Progress" in data
+    assert "event: FileDone" in data
+    assert "event: done" in data