blob-viewer 0.1.0__tar.gz

blob_viewer-0.1.0/.gitignore

@@ -0,0 +1,220 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#   Usually these files are written by a python script from a template
+#   before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+*.lcov
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+# Pipfile.lock
+
+# uv
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+# uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+# poetry.lock
+# poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+# pdm.lock
+# pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+# pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi/*
+!.pixi/config.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule*
+celerybeat.pid
+
+# Redis
+*.rdb
+*.aof
+*.pid
+
+# RabbitMQ
+mnesia/
+rabbitmq/
+rabbitmq-data/
+
+# ActiveMQ
+activemq-data/
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs/Zensical documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#   JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#   be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#   and can be added to the global gitignore or merged into this file.  For a more nuclear
+#   option (not recommended) you can uncomment the following to ignore the entire idea folder.
+# .idea/
+
+# Abstra
+#   Abstra is an AI-powered process automation framework.
+#   Ignore directories containing user credentials, local state, and settings.
+#   Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#   Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore that
+#   can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#   and can be added to the global gitignore or merged into this file. However, if you prefer, you
+#   could uncomment the following to ignore the entire vscode folder
+# .vscode/
+# Temporary file for partial code execution
+tempCodeRunnerFile.py
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml

blob_viewer-0.1.0/CHANGELOG.md

@@ -0,0 +1,24 @@
+# Changelog
+
+All notable changes to Blob Viewer are documented here. Format based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/); versioning follows [SemVer](https://semver.org/).
+
+## [0.1.0] — 2026-10-11
+
+First public release.
+
+### Added
+
+- Multiple workspaces: S3-compatible buckets (AWS S3, MinIO, RustFS, Backblaze B2, Cloudflare R2, DigitalOcean Spaces, Wasabi…) and local folders.
+- Universal file preview: markdown (sanitised), source code with syntax highlighting (26 languages), PDF (pdf.js), images, audio, video, CSV tables and plain text.
+- Local download cache with ETag-based version tracking, "update available" badges and one-click sync. Download-once semantics; offline access to cached files.
+- OneDrive/MinIO-style web UI: sidebar workspaces, breadcrumbs, list/grid views, sorting, workspace-wide search, context menus, toasts.
+- Eight themes (5 dark, 3 light) switchable live from the UI or CLI.
+- Fully vendored frontend (marked, DOMPurify, highlight.js, pdf.js) — no CDN, air-gap friendly.
+- Encrypted credential storage (Fernet at rest, redacted everywhere else).
+- Locked mode (`--locked`) with master-admin bootstrap, PBKDF2 password hashing and server-side sessions.
+- Guided CLI: `init`, `run`, `serve`, `workspace`, `user`, `cache`, `theme`, `doctor`, `version` — interactive and scriptable.
+- Desktop app (pywebview) with automatic server-mode fallback.
+- Docker image (multi-stage, non-root, ~195 MB) with healthcheck and volume-based persistence.
+- Comprehensive docs, HTTP API reference and tests (unit, API, real-S3 e2e, Playwright browser e2e).
+
+[0.1.0]: https://github.com/jasonjimnz/blob-viewer/releases/tag/v0.1.0

blob_viewer-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Jason Jiménez Cruz
+
+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.

blob_viewer-0.1.0/PKG-INFO

@@ -0,0 +1,206 @@
+Metadata-Version: 2.5
+Name: blob-viewer
+Version: 0.1.0
+Summary: A personal S3/MinIO bucket browser and file previewer. Desktop app (pywebview) and server, with a local download cache, multiple workspaces and a guided CLI.
+Project-URL: Homepage, https://github.com/jasonjimnz/blob-viewer
+Project-URL: Documentation, https://github.com/jasonjimnz/blob-viewer#readme
+Project-URL: Repository, https://github.com/jasonjimnz/blob-viewer
+Project-URL: Issues, https://github.com/jasonjimnz/blob-viewer/issues
+Project-URL: Changelog, https://github.com/jasonjimnz/blob-viewer/blob/main/CHANGELOG.md
+Author-email: Jason Jiménez Cruz <jasonjimenezcruz@gmail.com>
+License: MIT License
+        
+        Copyright (c) 2026 Jason Jiménez Cruz
+        
+        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.
+License-File: LICENSE
+Keywords: blob,boto3,bucket-browser,file-preview,minio,pywebview,s3,viewer
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Web Environment
+Classifier: Environment :: X11 Applications
+Classifier: Intended Audience :: End Users/Desktop
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Desktop Environment :: File Managers
+Classifier: Topic :: Utilities
+Requires-Python: >=3.11
+Requires-Dist: boto3>=1.35
+Requires-Dist: cryptography>=43.0
+Requires-Dist: flask>=3.1
+Requires-Dist: pywebview>=5.4; python_version >= '3.11'
+Requires-Dist: rich>=13.9
+Requires-Dist: waitress>=3.0
+Provides-Extra: dev
+Requires-Dist: build>=1.2; extra == 'dev'
+Requires-Dist: hatchling>=1.27; extra == 'dev'
+Requires-Dist: markdown>=3.7; extra == 'dev'
+Requires-Dist: pytest-cov>=6.0; extra == 'dev'
+Requires-Dist: pytest>=8.3; extra == 'dev'
+Requires-Dist: ruff>=0.8; extra == 'dev'
+Requires-Dist: twine>=6.0; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# Blob Viewer
+
+**A personal S3/MinIO bucket browser and file previewer.**
+
+Blob Viewer connects to any S3-compatible bucket — AWS S3, MinIO, Backblaze B2, Cloudflare R2, DigitalOcean Spaces, Wasabi — or to a plain local folder, and gives you a fast, modern file browser with previews for markdown, source code, PDFs, images, audio, video, CSV and more. Every file you open is cached locally, so your workspace is always available — even offline — and nothing is downloaded twice.
+
+> Built for personal use by [Jason Jiménez Cruz](https://github.com/jasonjimnz).
+
+## Highlights
+
+- **Many workspaces** — register as many S3 buckets or local folders as you want and switch between them instantly.
+- **Universal preview** — markdown, code with syntax highlighting, PDF, images, audio, video, CSV tables, plain text. Anything else is one click away as a download.
+- **Local download cache** — files are fetched once and reused. When a newer version exists upstream, Blob Viewer tells you and lets you sync.
+- **Remote workspaces are read-only** — blobs are never modified in place. Local workspaces stay fully writable.
+- **Encrypted credentials** — access keys are encrypted at rest and always redacted in the UI and API; nobody can read them back from a config dump.
+- **Locked mode** — start with `--locked` to require a master-admin login in the desktop app and the server.
+- **Runs anywhere** — as a desktop app (pywebview), a headless server, or a small Docker container. The frontend is plain HTML/JS/CSS with vendored libraries: no CDN, no build step, works in isolated environments.
+- **Many themes** — dark, light and coloured themes switchable from the UI.
+
+## Install
+
+```bash
+pip install blob-viewer
+```
+
+Python 3.11+ (3.13 recommended). For the desktop window on Linux you may need GTK/Qt libraries (`sudo apt install python3-gi gir1.2-webkit2-4.1` on Debian/Ubuntu); on Windows and macOS there are no extra requirements. If a GUI is unavailable, use server mode — everything works in the browser.
+
+## Quick start
+
+```bash
+# guided setup: create your first workspace, pick a theme
+blob-viewer init
+
+# open the desktop app
+blob-viewer run
+
+# or serve it on the network (e.g. a home server / container)
+blob-viewer serve --host 0.0.0.0 --port 8585
+```
+
+Then open <http://127.0.0.1:8585> if you used `serve`.
+
+### Locked mode
+
+```bash
+# first run asks you to create the master admin
+blob-viewer run --locked
+
+# CLI login is enforced in the desktop app and the server
+blob-viewer serve --locked
+```
+
+## Managing workspaces
+
+```bash
+blob-viewer workspace add          # guided wizard (S3 or local)
+blob-viewer workspace list
+blob-viewer workspace test my-bucket
+blob-viewer workspace remove my-bucket
+```
+
+Or do everything from the UI: **Settings → Workspaces → Add workspace**.
+
+| Field | S3 workspace | Local workspace |
+|---|---|---|
+| Endpoint | `https://s3.amazonaws.com`, `http://localhost:9000`, ... | — |
+| Bucket | required | — |
+| Access / Secret key | encrypted at rest | — |
+| Region | optional (`us-east-1` default) | — |
+| Prefix | optional root path inside the bucket | — |
+| Path style | on by default (MinIO/R2/B2) | — |
+| Folder | — | any local path |
+| Writable | never (read-only by design) | yes |
+
+## CLI overview
+
+```
+blob-viewer init                     Guided first-run configuration
+blob-viewer run [--locked] [--port]  Launch the desktop app
+blob-viewer serve [--locked]         Headless server mode
+blob-viewer workspace add|list|show|test|remove|edit
+blob-viewer user create|reset|status Master admin for locked mode
+blob-viewer cache stats|clear        Inspect / empty the download cache
+blob-viewer theme list|set           Change the UI theme
+blob-viewer doctor                   Diagnose installation problems
+blob-viewer version                  Show version
+```
+
+Run `blob-viewer <command> --help` for details on every command.
+
+## Where is my data?
+
+Everything lives in one folder (default `~/.blob-viewer`, override with `BLOB_VIEWER_HOME` or `--home`):
+
+```
+~/.blob-viewer/
+├── blob-viewer.db    # workspaces, settings, cache index (secrets encrypted)
+├── secrets.key       # per-installation encryption key (chmod 600)
+└── cache/            # downloaded files, one folder per workspace
+```
+
+Delete the folder = factory reset. Credentials are encrypted with a key that never leaves your machine; the API never returns secret values, only masked hints like `••••ab12`.
+
+## Docker
+
+```bash
+docker run -d --name blob-viewer \
+  -p 8585:8585 -v blob-viewer-data:/data \
+  ghcr.io/jasonjimnz/blob-viewer:latest
+```
+
+The image is multi-stage, runs as a non-root user and stores state in the `/data` volume. `--locked` is honoured via the `BLOB_VIEWER_LOCKED=1` environment variable or the container command.
+
+## Documentation
+
+Full documentation lives in [`docs/`](docs/index.md):
+
+- [Installation](docs/install.md)
+- [Getting started](docs/getting-started.md)
+- [Workspaces](docs/workspaces.md)
+- [File preview & the cache](docs/preview-cache.md)
+- [Security & locked mode](docs/security.md)
+- [CLI reference](docs/cli.md)
+- [HTTP API reference](docs/api.md)
+- [Themes & customisation](docs/themes.md)
+- [Docker deployment](docs/docker.md)
+- [Architecture](docs/architecture.md)
+- [Troubleshooting / FAQ](docs/faq.md)
+
+## Development
+
+```bash
+git clone https://github.com/jasonjimnz/blob-viewer.git
+cd blob-viewer
+python -m venv .venv && .venv/Scripts/pip install -e .[dev]   # POSIX: .venv/bin/pip
+pytest            # unit tests
+pytest -m e2e     # end-to-end tests (needs Docker; uses a throwaway MinIO)
+```
+
+See [docs/architecture.md](docs/architecture.md) for a tour of the codebase and how the pieces fit together.
+
+## License
+
+[MIT](LICENSE) © Jason Jiménez Cruz

blob_viewer-0.1.0/README.md

@@ -0,0 +1,144 @@
+# Blob Viewer
+
+**A personal S3/MinIO bucket browser and file previewer.**
+
+Blob Viewer connects to any S3-compatible bucket — AWS S3, MinIO, Backblaze B2, Cloudflare R2, DigitalOcean Spaces, Wasabi — or to a plain local folder, and gives you a fast, modern file browser with previews for markdown, source code, PDFs, images, audio, video, CSV and more. Every file you open is cached locally, so your workspace is always available — even offline — and nothing is downloaded twice.
+
+> Built for personal use by [Jason Jiménez Cruz](https://github.com/jasonjimnz).
+
+## Highlights
+
+- **Many workspaces** — register as many S3 buckets or local folders as you want and switch between them instantly.
+- **Universal preview** — markdown, code with syntax highlighting, PDF, images, audio, video, CSV tables, plain text. Anything else is one click away as a download.
+- **Local download cache** — files are fetched once and reused. When a newer version exists upstream, Blob Viewer tells you and lets you sync.
+- **Remote workspaces are read-only** — blobs are never modified in place. Local workspaces stay fully writable.
+- **Encrypted credentials** — access keys are encrypted at rest and always redacted in the UI and API; nobody can read them back from a config dump.
+- **Locked mode** — start with `--locked` to require a master-admin login in the desktop app and the server.
+- **Runs anywhere** — as a desktop app (pywebview), a headless server, or a small Docker container. The frontend is plain HTML/JS/CSS with vendored libraries: no CDN, no build step, works in isolated environments.
+- **Many themes** — dark, light and coloured themes switchable from the UI.
+
+## Install
+
+```bash
+pip install blob-viewer
+```
+
+Python 3.11+ (3.13 recommended). For the desktop window on Linux you may need GTK/Qt libraries (`sudo apt install python3-gi gir1.2-webkit2-4.1` on Debian/Ubuntu); on Windows and macOS there are no extra requirements. If a GUI is unavailable, use server mode — everything works in the browser.
+
+## Quick start
+
+```bash
+# guided setup: create your first workspace, pick a theme
+blob-viewer init
+
+# open the desktop app
+blob-viewer run
+
+# or serve it on the network (e.g. a home server / container)
+blob-viewer serve --host 0.0.0.0 --port 8585
+```
+
+Then open <http://127.0.0.1:8585> if you used `serve`.
+
+### Locked mode
+
+```bash
+# first run asks you to create the master admin
+blob-viewer run --locked
+
+# CLI login is enforced in the desktop app and the server
+blob-viewer serve --locked
+```
+
+## Managing workspaces
+
+```bash
+blob-viewer workspace add          # guided wizard (S3 or local)
+blob-viewer workspace list
+blob-viewer workspace test my-bucket
+blob-viewer workspace remove my-bucket
+```
+
+Or do everything from the UI: **Settings → Workspaces → Add workspace**.
+
+| Field | S3 workspace | Local workspace |
+|---|---|---|
+| Endpoint | `https://s3.amazonaws.com`, `http://localhost:9000`, ... | — |
+| Bucket | required | — |
+| Access / Secret key | encrypted at rest | — |
+| Region | optional (`us-east-1` default) | — |
+| Prefix | optional root path inside the bucket | — |
+| Path style | on by default (MinIO/R2/B2) | — |
+| Folder | — | any local path |
+| Writable | never (read-only by design) | yes |
+
+## CLI overview
+
+```
+blob-viewer init                     Guided first-run configuration
+blob-viewer run [--locked] [--port]  Launch the desktop app
+blob-viewer serve [--locked]         Headless server mode
+blob-viewer workspace add|list|show|test|remove|edit
+blob-viewer user create|reset|status Master admin for locked mode
+blob-viewer cache stats|clear        Inspect / empty the download cache
+blob-viewer theme list|set           Change the UI theme
+blob-viewer doctor                   Diagnose installation problems
+blob-viewer version                  Show version
+```
+
+Run `blob-viewer <command> --help` for details on every command.
+
+## Where is my data?
+
+Everything lives in one folder (default `~/.blob-viewer`, override with `BLOB_VIEWER_HOME` or `--home`):
+
+```
+~/.blob-viewer/
+├── blob-viewer.db    # workspaces, settings, cache index (secrets encrypted)
+├── secrets.key       # per-installation encryption key (chmod 600)
+└── cache/            # downloaded files, one folder per workspace
+```
+
+Delete the folder = factory reset. Credentials are encrypted with a key that never leaves your machine; the API never returns secret values, only masked hints like `••••ab12`.
+
+## Docker
+
+```bash
+docker run -d --name blob-viewer \
+  -p 8585:8585 -v blob-viewer-data:/data \
+  ghcr.io/jasonjimnz/blob-viewer:latest
+```
+
+The image is multi-stage, runs as a non-root user and stores state in the `/data` volume. `--locked` is honoured via the `BLOB_VIEWER_LOCKED=1` environment variable or the container command.
+
+## Documentation
+
+Full documentation lives in [`docs/`](docs/index.md):
+
+- [Installation](docs/install.md)
+- [Getting started](docs/getting-started.md)
+- [Workspaces](docs/workspaces.md)
+- [File preview & the cache](docs/preview-cache.md)
+- [Security & locked mode](docs/security.md)
+- [CLI reference](docs/cli.md)
+- [HTTP API reference](docs/api.md)
+- [Themes & customisation](docs/themes.md)
+- [Docker deployment](docs/docker.md)
+- [Architecture](docs/architecture.md)
+- [Troubleshooting / FAQ](docs/faq.md)
+
+## Development
+
+```bash
+git clone https://github.com/jasonjimnz/blob-viewer.git
+cd blob-viewer
+python -m venv .venv && .venv/Scripts/pip install -e .[dev]   # POSIX: .venv/bin/pip
+pytest            # unit tests
+pytest -m e2e     # end-to-end tests (needs Docker; uses a throwaway MinIO)
+```
+
+See [docs/architecture.md](docs/architecture.md) for a tour of the codebase and how the pieces fit together.
+
+## License
+
+[MIT](LICENSE) © Jason Jiménez Cruz