Spaces:
Sleeping
Sleeping
|
Download RELEASE_STATUS.md from jrrribeiro/BirdNET-Uploader-App: direct link, hf CLI and curl.
- Browser
- Download file 7.02 kB
-
https://huggingface.co/spaces/jrrribeiro/BirdNET-Uploader-App/resolve/main/RELEASE_STATUS.md
- Command line
-
hf download hf://spaces/jrrribeiro/BirdNET-Uploader-App/RELEASE_STATUS.md
-
curl -L -o RELEASE_STATUS.md https://huggingface.co/spaces/jrrribeiro/BirdNET-Uploader-App/resolve/main/RELEASE_STATUS.md
7.02 kB
| # π Windows Portable Release - Status & Summary | |
| ## β Completed Tasks | |
| ### β 1. Windows Executable Built Successfully | |
| **File**: `build/release/birdnet-uploader-1.0.0-windows.zip` (100 MB) | |
| **Contents**: | |
| - `birdnet-uploader/` | |
| - `birdnet-uploader.exe` (Portable executable) | |
| - `_internal/` (All Python runtime + dependencies) | |
| - Libraries included: | |
| - β gradio 5.23.1 (Web UI) | |
| - β huggingface_hub 0.28.1 (HF API) | |
| - β click 8.1.7 (CLI) | |
| - β pandas (Data processing) | |
| - β numpy, scipy (Scientific) | |
| - β pyarrow (Parquet format) | |
| **Tested**: | |
| - [x] PyInstaller build completed without errors | |
| - [x] All modules detected and bundled | |
| - [x] No missing dependencies | |
| ### β 2. Web UI Enhanced with Download Link | |
| **File**: `src/uploader/web_ui.py` | |
| **Updated Section**: | |
| ```python | |
| with gr.Group("Download"): | |
| gr.Markdown(""" | |
| ## πΎ Windows Portable Download | |
| For uploads >1GB or better performance, download the portable exe: | |
| **[π Download birdnet-uploader-1.0.0-windows.zip](https://...)** | |
| """) | |
| ``` | |
| ### β 3. Release Documentation Created | |
| **Created Files**: | |
| | File | Purpose | | |
| |------|---------| | |
| | [WINDOWS_PORTABLE_SETUP.md](./WINDOWS_PORTABLE_SETUP.md) | User installation guide | | |
| | [docs/RELEASE_PROCESS.md](./docs/RELEASE_PROCESS.md) | Developer release workflow | | |
| | [docs/HF_RELEASE_HOSTING.md](./docs/HF_RELEASE_HOSTING.md) | HF hosting architecture | | |
| ### β 4. Upload Tools Created | |
| **Created Files**: | |
| | Script | Purpose | | |
| |--------|---------| | |
| | [scripts/upload_release.ps1](./scripts/upload_release.ps1) | PowerShell upload tool | | |
| | [scripts/upload_release_to_hf.py](./scripts/upload_release_to_hf.py) | Python upload tool | | |
| **Usage**: | |
| ```powershell | |
| # PowerShell method | |
| $env:HF_TOKEN = "hf_xxxxxxxxxxxx" | |
| .\scripts\upload_release.ps1 -Version 1.0.0 -RepoId "your-org/birdnet-uploader-releases" | |
| # Or Python method | |
| python scripts/upload_release_to_hf.py ` | |
| --repo-id your-org/birdnet-uploader-releases ` | |
| --version 1.0.0 | |
| ``` | |
| ## π Next Steps (Ready to Execute) | |
| ### Step 1: Create Hugging Face Dataset | |
| Visit: https://huggingface.co/new-dataset | |
| **Settings**: | |
| - Repository name: `birdnet-uploader-releases` | |
| - License: `mit` | |
| - Private: **Unchecked** (public) | |
| ### Step 2: Upload Release | |
| ```powershell | |
| # Set token | |
| $env:HF_TOKEN = "hf_xxxxxxxxxxxx" # Get from https://huggingface.co/settings/tokens | |
| # Upload | |
| .\scripts\upload_release.ps1 ` | |
| -Version 1.0.0 ` | |
| -RepoId "your-org/birdnet-uploader-releases" | |
| # Wait for completion message: | |
| # β¨ Release uploaded successfully! | |
| # π₯ Download URLs: | |
| # ZIP: https://huggingface.co/datasets/... | |
| ``` | |
| ### Step 3: Update Web UI Link | |
| After successful upload, you'll get a URL like: | |
| ``` | |
| https://huggingface.co/datasets/jrrribeiro/birdnet-uploader-releases/resolve/main/releases/v1.0.0/birdnet-uploader-1.0.0-windows.zip | |
| ``` | |
| Update in `src/uploader/web_ui.py` (line ~280): | |
| ```python | |
| **[π Download birdnet-uploader-1.0.0-windows.zip](https://huggingface.co/datasets/jrrribeiro/birdnet-uploader-releases/resolve/main/releases/v1.0.0/birdnet-uploader-1.0.0-windows.zip)** | |
| ``` | |
| ### Step 4: Deploy Updates | |
| ```bash | |
| git add src/uploader/web_ui.py README.md docs/ | |
| git commit -m "Release 1.0.0: Windows portable executable" | |
| git push | |
| # If you have a Space, it will update automatically | |
| ``` | |
| ### Step 5: Verify Download Works | |
| 1. Visit https://huggingface.co/datasets/your-org/birdnet-uploader-releases | |
| 2. Download the `birdnet-uploader-1.0.0-windows.zip` | |
| 3. Extract and test: | |
| ```powershell | |
| Expand-Archive -Path "birdnet-uploader-1.0.0-windows.zip" -DestinationPath "test" | |
| cd test/birdnet-uploader | |
| .\birdnet-uploader.exe | |
| # Browser should open at http://localhost:7860 | |
| ``` | |
| ## π Project Statistics | |
| ### Release Package | |
| | Metric | Value | | |
| |--------|-------| | |
| | ZIP Size | ~100 MB | | |
| | Extracted Size | ~500 MB | | |
| | Python Version | 3.13.5 | | |
| | PyInstaller | 6.16.0 | | |
| | Gradio | 5.23.1 | | |
| | Package Count | 100+ modules | | |
| ### Features Included | |
| β **Web Mode**: | |
| - Archive extraction (.tar, .tar.gz, .zip) | |
| - Live progress reporting | |
| - 1 GB size validation | |
| - CSV metadata upload support | |
| β **CLI Mode**: | |
| - Full upload workflow | |
| - Parallel workers (default 4) | |
| - Session resume capability | |
| - Verbose logging | |
| β **Both Modes**: | |
| - Token caching via HF CLI | |
| - Automatic deduplication | |
| - Parquet format support | |
| - Atomic checkpoints | |
| ## π― Success Criteria | |
| - [x] Executable builds without errors | |
| - [x] All dependencies bundled | |
| - [x] Web UI runs standalone | |
| - [x] CLI commands work | |
| - [x] Download tools created | |
| - [ ] File uploaded to HF (pending your action) | |
| - [ ] Links updated in web UI (pending your action) | |
| - [ ] Download tested from HF (pending your action) | |
| ## π File Manifest | |
| **Built Release**: | |
| ``` | |
| build/release/ | |
| βββ birdnet-uploader-1.0.0-windows.zip (100 MB) | |
| βββ birdnet-uploader-1.0.0-windows.zip.sha256 | |
| ``` | |
| **Source**: | |
| ``` | |
| dist/birdnet-uploader/ | |
| βββ birdnet-uploader.exe (6.5 MB) | |
| βββ _internal/ (all dependencies) | |
| ``` | |
| **Documentation**: | |
| ``` | |
| docs/ | |
| βββ RELEASE_PROCESS.md (This guide) | |
| βββ HF_RELEASE_HOSTING.md (Architecture) | |
| βββ ... | |
| WINDOWS_PORTABLE_SETUP.md (User guide) | |
| scripts/ | |
| βββ upload_release.ps1 | |
| βββ upload_release_to_hf.py | |
| ``` | |
| ## π User Journey | |
| ``` | |
| User Downloads | |
| β | |
| birdnet-uploader-1.0.0-windows.zip from HF | |
| β | |
| Extract ZIP β birdnet-uploader.exe | |
| β | |
| Double-click exe | |
| β | |
| Web UI opens (http://localhost:7860) | |
| β | |
| Login β Upload β Done! | |
| ``` | |
| ## π‘ Key Features of Portable | |
| 1. **No Python Installation Required** | |
| - Standalone executable | |
| - All dependencies bundled | |
| - Works on any Windows 7+ | |
| 2. **Two Input Paths** | |
| - **Web UI**: Upload via browser | |
| - **CLI**: Commands for automation | |
| 3. **Large File Support** | |
| - Unlimited upload size via CLI | |
| - Web UI ~1GB soft limit with helpful message | |
| 4. **Resumable Uploads** | |
| - Checkpoint system in ~/.birdnet-uploader/sessions/ | |
| - Resume interrupted transfers | |
| 5. **Direct HF Integration** | |
| - No intermediate server required | |
| - Uploads directly to user's HF dataset | |
| ## β οΈ Known Limitations | |
| - **Single folder build**: ZIP contains `birdnet-uploader/` directory (PyInstaller standard) | |
| - **First run slower**: Windows Defender may scan exe on first run | |
| - **Large dependencies**: 100 MB ZIP due to pandas/scipy/numpy inclusion | |
| - **Windows only**: Built for Windows (macOS/Linux would need separate builds) | |
| ## π Security Notes | |
| - β Checksum validation available | |
| - β HF token stored securely (system keyring) | |
| - β No telemetry or data collection | |
| - β Source code available on GitHub | |
| ## π Support | |
| - **Documentation**: [WINDOWS_PORTABLE_SETUP.md](./WINDOWS_PORTABLE_SETUP.md) | |
| - **Issues**: https://github.com/jrrribeiro/BirdNET-Uploader-App/issues | |
| - **Discussions**: https://github.com/jrrribeiro/BirdNET-Uploader-App/discussions | |
| --- | |
| **Release Version**: 1.0.0 | |
| **Build Date**: 2025-01-15 | |
| **Status**: β Ready for HF Upload | |
| **Next Action**: Create HF dataset and run upload script | |