pineapplee 0.1.1

A beautiful, feature-rich local file server

🍍 Pineapplee

A clean, fast, local file server — right in your browser.

PyPI · GitHub · Report a Bug

---

Pineapplee turns any folder on your machine into a shareable web interface — browse, upload, download, and manage files from any device on your network, or share publicly with a single flag.

---

✨ Features

📁 Browse & Navigate	Clean file listing with sortable columns, breadcrumb trail, and folder navigation
⬆️ Upload	Drag-and-drop files or entire folders — with real-time progress
⬇️ Download	Single files or bulk ZIP archives
👁️ Preview	Images, video, audio, PDFs, and text files — all in-browser
✏️ Rename & Delete	Manage files without leaving the browser
🌍 Public Share	One flag to expose your server publicly via Cloudflare Tunnel — no account needed
🔒 Safe by default	Path traversal protection, symlink validation, upload size limits

---

🚀 Quick Start

pip install pineapplee

# Serve the current directory
pineapplee

# Serve a specific path
pineapplee ~/Downloads

# Different port
pineapplee --port 9000

# Share publicly over the internet
pineapplee --public

Open http://localhost:8089 — and you're in.

---

📖 Usage

usage: pineapplee [-h] [--port PORT] [--public] [directory]

positional arguments:
  directory       Directory to serve (default: current directory)

options:
  -h, --help      show this help message and exit
  --port, -p      Port to listen on (default: 8089)
  --public        Expose publicly via Cloudflare Tunnel

Local network sharing

Pineapple binds to 0.0.0.0, so any device on your LAN can reach it at the Network URL printed in the terminal:

  ┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
  ┃ 🍍 Pineapple File Server                  ┃
  ┣━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┫
  ┃                                           ┃
  ┃   📂 Serving     /Users/you/Documents     ┃
  ┃   🔗 Local       http://localhost:8089    ┃
  ┃   🌐 Network     http://192.168.1.5:8089  ┃
  ┃   📦 Max upload  500 MB                   ┃
  ┃                                           ┃
  ┣━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┫
  ┃   Press Ctrl+C to stop                    ┃
  ┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛

Public sharing

pineapplee --public

On first run this downloads the cloudflared binary (~50 MB, cached to ~/.pineapplee/bin/). A public trycloudflare.com URL is printed — share it with anyone, anywhere.

---

🔒 Security

• All file paths are validated and confined to the served directory
• Symlinks pointing outside the root are silently ignored
• Upload size capped at 500 MB by default
• Hidden files (dotfiles, __pycache__, node_modules, .egg-info, etc.) are never shown

Note: Pineapple is designed for local and trusted-network use. Do not expose it to the public internet without understanding the implications.

---

📋 Requirements

• Python ≥ 3.8
• Flask ≥ 2.0

---

🛠 Contributing & Development

# 1. Clone the repo
git clone https://github.com/ApoorvDixitt/Pinapplee.git
cd Pinapplee

# 2. Install in editable mode
pip install -e .

# 3. Run locally
pineapplee

Publishing a new version to PyPI

1. Edit the version in two places:

   • pyproject.toml → version = "x.y.z"
   • pineapplee/__init__.py → __version__ = 'x.y.z'

2. Build the package:

   pip install build twine
   python -m build
   

3. Upload to PyPI:

   twine upload dist/*
   # Username: __token__
   # Password: <your PyPI API token>
   

Tip: create a ~/.pypirc file to avoid typing credentials every time:

[pypi]
username = __token__
password = pypi-your-token-here

---

📄 License

MIT © KalaaKaar