flashstudio 0.1.8__tar.gz → 0.2.0__tar.gz

{flashstudio-0.1.8 → flashstudio-0.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: flashstudio
-Version: 0.1.8
+Version: 0.2.0
 Summary: Interactive Training & Inference UI for FlashDet — runs on Google Colab
 Author: FlashVision
 License: Apache-2.0
@@ -19,17 +19,15 @@ Requires-Dist: plotly>=5.0
 Requires-Dist: pandas>=1.5
 Requires-Dist: pillow>=9.0
 Requires-Dist: numpy>=1.21
-Requires-Dist: pyngrok>=6.0
 Requires-Dist: opencv-python>=4.5
 Requires-Dist: pyyaml>=6.0
 Requires-Dist: flashdet
 Provides-Extra: full
-Requires-Dist: pyngrok>=6.0; extra == "full"
 Requires-Dist: torch>=2.0; extra == "full"
-Requires-Dist: opencv-python>=4.5; extra == "full"
 Requires-Dist: flashdet[export]; extra == "full"
-Provides-Extra: colab
-Requires-Dist: pyngrok>=6.0; extra == "colab"
+Requires-Dist: pyngrok>=6.0; extra == "full"
+Provides-Extra: ngrok
+Requires-Dist: pyngrok>=6.0; extra == "ngrok"
 Provides-Extra: dev
 Requires-Dist: ruff; extra == "dev"
 Requires-Dist: pytest; extra == "dev"

{flashstudio-0.1.8 → flashstudio-0.2.0}/README.md

@@ -28,7 +28,7 @@
 - 📤 **Export** — ONNX export with FP16 auto-generated weights
 - 📦 **Data** — Native `flashdet download` datasets + custom upload (COCO/VOC/YOLO formats)
 - 📊 **Dashboard** — Overview with recent training runs from workspace
-- 🚀 **Colab Support** — ngrok tunneling for remote access
+- 🚀 **Colab Support** — Works out-of-the-box, no token or signup needed
 
 ---
 
@@ -80,19 +80,14 @@ Full inference pipeline with 17 built-in solutions (object counting, speed estim
 
 ## Installation
 
-### Step 1: Install FlashStudio
-
 ```bash
 pip install flashstudio
 ```
 
-### Step 2: Install FlashDet (required for training/inference)
-
-```bash
-pip install git+https://github.com/FlashVision/FlashDet.git
-```
+This automatically installs FlashDet and all other dependencies.
 
-### Development install (from source)
+<details>
+<summary><b>Development install (from source)</b></summary>
 
 ```bash
 git clone https://github.com/FlashVision/FlashStudio.git
@@ -100,6 +95,8 @@ cd FlashStudio
 pip install -e .
 ```
 
+</details>
+
 ---
 
 ## Usage — Local Machine
@@ -123,53 +120,46 @@ Then open **http://localhost:8501** in your browser.
 
 ## Usage — Google Colab
 
-### Step 1: Install packages
+No signup or token needed. Just 2 steps:
+
+### Step 1: Install
+
+```python
+!pip install -q flashstudio
+```
+
+### Step 2: Launch
 
 ```python
-!pip install flashstudio
-!pip install git+https://github.com/FlashVision/FlashDet.git
+from flashstudio import launch
+launch()
 ```
 
-### Step 2: Get ngrok token (free, one-time setup)
+A clickable **"Open FlashStudio"** button appears in the cell output. Click it to open the UI.
 
-FlashStudio uses [ngrok](https://ngrok.com) to create a public URL for the Streamlit UI in Colab.
+FlashStudio auto-detects Colab and uses the built-in proxy to create a working URL — no `localhost`, no ngrok, no token.
 
-1. **Sign up** (free): https://dashboard.ngrok.com/signup
-2. **Get your auth token**: https://dashboard.ngrok.com/get-started/your-authtoken
-3. Copy the token (looks like `2xAbC1234_something...`)
+<details>
+<summary><b>Optional: ngrok for a stable public URL</b></summary>
 
-### Step 3: Launch
+If the built-in proxy doesn't work for your setup, you can use ngrok as a fallback:
 
-```python
-from flashstudio import launch
+1. Get a free token at https://dashboard.ngrok.com/get-started/your-authtoken
+2. Pass it when launching:
 
-# Pass your ngrok token
-launch(ngrok_token="YOUR_NGROK_TOKEN_HERE")
+```python
+launch(ngrok_token="YOUR_TOKEN")
 ```
 
 Or set it as an environment variable:
 
 ```python
 import os
-os.environ["NGROK_TOKEN"] = "YOUR_NGROK_TOKEN_HERE"
-
-from flashstudio import launch
+os.environ["NGROK_TOKEN"] = "YOUR_TOKEN"
 launch()
 ```
 
-### Step 4: Open the URL
-
-After launching, you'll see output like:
-
-```
-============================================================
-  FlashStudio is running!
-  Local:  http://localhost:8501
-  Public: https://abc123.ngrok-free.app
-============================================================
-```
-
-Click the **Public URL** to open FlashStudio in a new tab.
+</details>
 
 ---
 
@@ -203,7 +193,7 @@ FlashStudio/
 ├── flashstudio/
 │   ├── __init__.py                  # Package init + launch() export
 │   ├── app.py                       # Main Streamlit app (wizard flow)
-│   ├── launcher.py                  # Colab/local launcher with ngrok
+│   ├── launcher.py                  # Colab/local launcher (auto-tunnel)
 │   ├── cli.py                       # CLI entrypoint
 │   ├── constants.py                 # Centralized constants (paths, defaults, models)
 │   │
@@ -297,26 +287,32 @@ FlashStudio/
 
 ## Troubleshooting
 
-### `ModuleNotFoundError: No module named 'pyngrok'`
-
-```bash
-pip install --upgrade flashstudio
-```
+### Colab: "localhost can't be reached" or ngrok error
 
-### ngrok authentication error (`ERR_NGROK_4018`)
+`launch()` uses Colab's built-in proxy automatically. If it doesn't work, run this in a **new cell**:
 
-You need an ngrok auth token. Get one free at:
-https://dashboard.ngrok.com/get-started/your-authtoken
+```python
+import subprocess, sys, time
+
+proc = subprocess.Popen(
+    [sys.executable, "-m", "streamlit", "run",
+     __import__('flashstudio.launcher', fromlist=['_get_app_path'])._get_app_path(),
+     "--server.port", "8501", "--server.headless", "true",
+     "--server.enableCORS", "false", "--server.enableXsrfProtection", "false"],
+    stdout=subprocess.PIPE, stderr=subprocess.PIPE
+)
+time.sleep(5)
+
+from google.colab.output import eval_js
+print(eval_js("google.colab.kernel.proxyPort(8501)"))
+```
 
-Then pass it to `launch(ngrok_token="your_token")`.
+Open the printed URL in a new tab. No token or signup needed.
 
 ### Streamlit port already in use
 
 ```bash
-# Kill existing Streamlit processes
 pkill -f "streamlit run"
-
-# Then restart
 flashstudio --port 8501
 ```
 
@@ -324,10 +320,10 @@ flashstudio --port 8501
 
 ## Requirements
 
-- Python >= 3.9
-- FlashDet (`pip install git+https://github.com/FlashVision/FlashDet.git`)
-- ngrok account (free) for Google Colab usage
+- Python >= 3.10
 - GPU recommended for training (T4 or better)
+- Google Colab works out-of-the-box (no extra accounts needed)
+- FlashDet installs automatically with `pip install flashstudio`
 
 ## License
 

flashstudio-0.2.0/flashstudio/launcher.py

@@ -0,0 +1,183 @@
+"""Launch FlashStudio UI — works locally and inside Google Colab."""
+
+import subprocess
+import sys
+import os
+from pathlib import Path
+
+from flashstudio.utils.device import is_colab
+
+_STREAMLIT_CONFIG = """\
+[theme]
+primaryColor = "#7C3AED"
+backgroundColor = "#FFFFFF"
+secondaryBackgroundColor = "#F8F9FB"
+textColor = "#1A1A2E"
+font = "sans serif"
+
+[server]
+headless = true
+port = 8501
+enableCORS = false
+enableXsrfProtection = false
+
+[client]
+showSidebarNavigation = false
+
+[browser]
+gatherUsageStats = false
+"""
+
+
+def _get_app_path() -> str:
+    return str(Path(__file__).parent / "app.py")
+
+
+def _ensure_streamlit_config():
+    """Write the default Streamlit config if one doesn't already exist."""
+    config_dir = Path.home() / ".streamlit"
+    config_file = config_dir / "config.toml"
+    if config_file.exists():
+        return
+    config_dir.mkdir(parents=True, exist_ok=True)
+    config_file.write_text(_STREAMLIT_CONFIG)
+
+
+def launch(port: int = 8501, share: bool = True, ngrok_token: str | None = None):
+    """Launch FlashStudio Streamlit app.
+
+    Args:
+        port: Port to run the Streamlit server on.
+        share: If True and running in Colab, creates a public ngrok tunnel.
+        ngrok_token: Optional ngrok auth token. If not provided, uses NGROK_TOKEN env var.
+    """
+    _ensure_streamlit_config()
+    app_path = _get_app_path()
+
+    if is_colab():
+        return _launch_colab(app_path, port, share, ngrok_token)
+    else:
+        _launch_local(app_path, port)
+        return None
+
+
+def _launch_colab(app_path: str, port: int, share: bool, ngrok_token: str | None):
+    """Launch in Google Colab with automatic tunnel detection."""
+    import time as _time
+    import urllib.request
+    import urllib.error
+
+    print("  Starting FlashStudio...", end="", flush=True)
+
+    proc = subprocess.Popen(
+        [sys.executable, "-m", "streamlit", "run", app_path,
+         "--server.port", str(port),
+         "--server.headless", "true",
+         "--server.enableCORS", "false",
+         "--server.enableXsrfProtection", "false"],
+        stdout=subprocess.PIPE,
+        stderr=subprocess.PIPE,
+    )
+
+    # Wait until Streamlit is actually responding (up to 30s)
+    ready = False
+    for i in range(30):
+        _time.sleep(1)
+        if proc.poll() is not None:
+            _, stderr = proc.communicate()
+            err_msg = stderr.decode("utf-8", errors="replace")[-500:] if stderr else "Unknown error"
+            print(f"\n\n  FlashStudio failed to start:\n  {err_msg}")
+            return proc
+        try:
+            urllib.request.urlopen(f"http://localhost:{port}/_stcore/health", timeout=2)
+            ready = True
+            break
+        except Exception:
+            print(".", end="", flush=True)
+
+    if ready:
+        print(" Ready!")
+    else:
+        print(" (still loading, URL may take a moment)")
+
+    public_url = None
+
+    # Method 1: Colab's built-in proxy (simplest, no install needed)
+    try:
+        from google.colab.output import eval_js
+        result = eval_js(f"google.colab.kernel.proxyPort({port})")
+        if result and str(result).startswith("http"):
+            public_url = str(result)
+    except Exception:
+        pass
+
+    # Method 2: ngrok (only if token is provided)
+    if not public_url:
+        token = ngrok_token or os.environ.get("NGROK_TOKEN", "")
+        if token:
+            try:
+                from pyngrok import ngrok, conf
+                conf.get_default().auth_token = token
+                public_url = str(ngrok.connect(port, "http"))
+            except ImportError:
+                try:
+                    subprocess.check_call(
+                        [sys.executable, "-m", "pip", "install", "-q", "pyngrok"],
+                        stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL,
+                    )
+                    from pyngrok import ngrok, conf
+                    conf.get_default().auth_token = token
+                    public_url = str(ngrok.connect(port, "http"))
+                except Exception:
+                    pass
+            except Exception:
+                pass
+
+    print(f"\n{'=' * 60}")
+    print("  FlashStudio is running!")
+    if public_url:
+        print(f"  Open: {public_url}")
+    else:
+        print(f"  Port: {port}")
+        print("")
+        print("  Run this in a new cell to get the URL:")
+        print(f"    from google.colab.output import eval_js")
+        print(f"    print(eval_js('google.colab.kernel.proxyPort({port})'))")
+    print(f"{'=' * 60}\n")
+
+    if public_url:
+        try:
+            from IPython.display import display, HTML
+            display(HTML(
+                f'<a href="{public_url}" target="_blank" '
+                f'style="display:inline-block;font-size:16px;padding:10px 24px;'
+                f'background:#7C3AED;color:white;border-radius:8px;'
+                f'text-decoration:none;font-weight:600;margin:8px 0;">'
+                f'Open FlashStudio</a>'
+            ))
+        except Exception:
+            pass
+    else:
+        try:
+            from IPython.display import display, HTML
+            display(HTML(
+                f'<div style="padding:12px;background:#FEF3C7;border-radius:8px;'
+                f'margin:8px 0;font-size:14px;">'
+                f'Run in a <b>new cell</b>:<br>'
+                f'<code style="background:#F3F4F6;padding:4px 8px;border-radius:4px;">'
+                f'from google.colab.output import eval_js; '
+                f'print(eval_js("google.colab.kernel.proxyPort({port})"))</code>'
+                f'</div>'
+            ))
+        except Exception:
+            pass
+
+    return proc
+
+
+def _launch_local(app_path: str, port: int):
+    """Launch locally with streamlit."""
+    subprocess.run(
+        [sys.executable, "-m", "streamlit", "run", app_path,
+         "--server.port", str(port)],
+    )

{flashstudio-0.1.8 → flashstudio-0.2.0}/flashstudio.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: flashstudio
-Version: 0.1.8
+Version: 0.2.0
 Summary: Interactive Training & Inference UI for FlashDet — runs on Google Colab
 Author: FlashVision
 License: Apache-2.0
@@ -19,17 +19,15 @@ Requires-Dist: plotly>=5.0
 Requires-Dist: pandas>=1.5
 Requires-Dist: pillow>=9.0
 Requires-Dist: numpy>=1.21
-Requires-Dist: pyngrok>=6.0
 Requires-Dist: opencv-python>=4.5
 Requires-Dist: pyyaml>=6.0
 Requires-Dist: flashdet
 Provides-Extra: full
-Requires-Dist: pyngrok>=6.0; extra == "full"
 Requires-Dist: torch>=2.0; extra == "full"
-Requires-Dist: opencv-python>=4.5; extra == "full"
 Requires-Dist: flashdet[export]; extra == "full"
-Provides-Extra: colab
-Requires-Dist: pyngrok>=6.0; extra == "colab"
+Requires-Dist: pyngrok>=6.0; extra == "full"
+Provides-Extra: ngrok
+Requires-Dist: pyngrok>=6.0; extra == "ngrok"
 Provides-Extra: dev
 Requires-Dist: ruff; extra == "dev"
 Requires-Dist: pytest; extra == "dev"

{flashstudio-0.1.8 → flashstudio-0.2.0}/flashstudio.egg-info/requires.txt

@@ -3,21 +3,19 @@ plotly>=5.0
 pandas>=1.5
 pillow>=9.0
 numpy>=1.21
-pyngrok>=6.0
 opencv-python>=4.5
 pyyaml>=6.0
 flashdet
 
-[colab]
-pyngrok>=6.0
-
 [dev]
 ruff
 pytest
 pytest-cov
 
 [full]
-pyngrok>=6.0
 torch>=2.0
-opencv-python>=4.5
 flashdet[export]
+pyngrok>=6.0
+
+[ngrok]
+pyngrok>=6.0

{flashstudio-0.1.8 → flashstudio-0.2.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "flashstudio"
-version = "0.1.8"
+version = "0.2.0"
 description = "Interactive Training & Inference UI for FlashDet — runs on Google Colab"
 readme = "README_PYPI.md"
 license = {text = "Apache-2.0"}
@@ -25,7 +25,6 @@ dependencies = [
     "pandas>=1.5",
     "pillow>=9.0",
     "numpy>=1.21",
-    "pyngrok>=6.0",
     "opencv-python>=4.5",
     "pyyaml>=6.0",
     "flashdet",
@@ -33,12 +32,11 @@ dependencies = [
 
 [project.optional-dependencies]
 full = [
-    "pyngrok>=6.0",
     "torch>=2.0",
-    "opencv-python>=4.5",
     "flashdet[export]",
+    "pyngrok>=6.0",
 ]
-colab = ["pyngrok>=6.0"]
+ngrok = ["pyngrok>=6.0"]
 dev = ["ruff", "pytest", "pytest-cov"]
 
 [project.scripts]

flashstudio-0.1.8/flashstudio/launcher.py

@@ -1,104 +0,0 @@
-"""Launch FlashStudio UI — works locally and inside Google Colab."""
-
-import subprocess
-import sys
-import os
-from pathlib import Path
-
-from flashstudio.utils.device import is_colab
-
-_STREAMLIT_CONFIG = """\
-[theme]
-primaryColor = "#7C3AED"
-backgroundColor = "#FFFFFF"
-secondaryBackgroundColor = "#F8F9FB"
-textColor = "#1A1A2E"
-font = "sans serif"
-
-[server]
-headless = true
-port = 8501
-enableCORS = false
-enableXsrfProtection = false
-
-[client]
-showSidebarNavigation = false
-
-[browser]
-gatherUsageStats = false
-"""
-
-
-def _get_app_path() -> str:
-    return str(Path(__file__).parent / "app.py")
-
-
-def _ensure_streamlit_config():
-    """Write the default Streamlit config if one doesn't already exist."""
-    config_dir = Path.home() / ".streamlit"
-    config_file = config_dir / "config.toml"
-    if config_file.exists():
-        return
-    config_dir.mkdir(parents=True, exist_ok=True)
-    config_file.write_text(_STREAMLIT_CONFIG)
-
-
-def launch(port: int = 8501, share: bool = True, ngrok_token: str | None = None):
-    """Launch FlashStudio Streamlit app.
-
-    Args:
-        port: Port to run the Streamlit server on.
-        share: If True and running in Colab, creates a public ngrok tunnel.
-        ngrok_token: Optional ngrok auth token. If not provided, uses NGROK_TOKEN env var.
-    """
-    _ensure_streamlit_config()
-    app_path = _get_app_path()
-
-    if is_colab():
-        _launch_colab(app_path, port, share, ngrok_token)
-    else:
-        _launch_local(app_path, port)
-
-
-def _launch_colab(app_path: str, port: int, share: bool, ngrok_token: str | None):
-    """Launch in Google Colab with ngrok tunnel."""
-    try:
-        from pyngrok import ngrok, conf
-    except ImportError:
-        print("Installing pyngrok...")
-        subprocess.check_call([sys.executable, "-m", "pip", "install", "-q", "pyngrok"])
-        from pyngrok import ngrok, conf
-
-    token = ngrok_token or os.environ.get("NGROK_TOKEN", "")
-    if token:
-        conf.get_default().auth_token = token
-
-    proc = subprocess.Popen(
-        [sys.executable, "-m", "streamlit", "run", app_path,
-         "--server.port", str(port),
-         "--server.headless", "true",
-         "--server.enableCORS", "false",
-         "--server.enableXsrfProtection", "false"],
-        stdout=subprocess.PIPE,
-        stderr=subprocess.PIPE,
-    )
-
-    if share:
-        public_url = ngrok.connect(port, "http")
-        print(f"\n{'=' * 60}")
-        print("  FlashStudio is running!")
-        print(f"  Local:  http://localhost:{port}")
-        print(f"  Public: {public_url}")
-        print(f"{'=' * 60}\n")
-    else:
-        print(f"\n  FlashStudio running at http://localhost:{port}\n")
-
-    return proc
-
-
-def _launch_local(app_path: str, port: int):
-    """Launch locally with streamlit."""
-    subprocess.run(
-        [sys.executable, "-m", "streamlit", "run", app_path,
-         "--server.port", str(port)],
-    )