Metadata-Version: 2.4
Name: hubview
Version: 0.7
Summary: GitHub-like local file viewer built with Flask
Author-email: Grey Liedtke <grey.liedtke@gmail.com>
License: MIT
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: flask>=3.0
Requires-Dist: markdown>=3.6
Requires-Dist: pymdown-extensions>=10.8
Requires-Dist: beautifulsoup4>=4.12
Requires-Dist: pandas==2.3.2
Requires-Dist: MarkupSafe==3.0.2
Requires-Dist: Werkzeug==3.1.3
Dynamic: license-file

# HubView — GitHub‑like file viewer (Flask)

A clean, fast, local file viewer with a GitHub‑style UI. Browse folders, preview code with syntax highlighting, render Markdown (tables, task lists, admonitions), show images/video/audio/PDF, and even draw Mermaid diagrams via fenced blocks.

https://github.com/ (UI inspiration only)

### TODO

1. Instructions on running: hubview
   1. 251204


## Example Run Code

```python
from hubview import app
app.create_hub(
    root='./',
    host='0.0.0.0',
    port=3000,
    script_ex='.venv/bin/python',
    script_path='./',
    script_log='log.log'
)
```

Or:

in terminal, type:
hubview

## Quick start

1. pip install hubview
2. hubview --root 'your directory'
3. open **http://127.0.0.1:5000** in your browser.

## Features

- 🗂️ Directory browsing with breadcrumbs
- 📝 Markdown rendering with **pymdown-extensions** (tables, details, tasklists, emoji, etc.)
- 🧠 Mermaid diagrams via fenced blocks:  
  <code>```mermaid</code> … <code>```</code>
- 🎨 Client-side syntax highlighting using highlight.js
- 🖼️ Photo/image preview, plus audio/video and PDF embeds
- 📖 Auto-render `README.md` (or `index.md`) at the bottom of each directory
- 🛡️ Path safety (jailed to a root folder)
- 🌗 Looks good in light and dark


