qrdrop 0.1.0__tar.gz

qrdrop-0.1.0/.gitignore

@@ -0,0 +1,73 @@
+# Python
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+.Python
+*.egg
+*.egg-info/
+.installed.cfg
+*.eggs
+
+# Virtual environments
+.venv/
+venv/
+ENV/
+
+# Pixi
+.pixi/
+
+# Build outputs
+dist/
+build/
+wheels/
+
+# Testing
+.coverage
+.coverage.*
+htmlcov/
+.pytest_cache/
+.tox/
+.nox/
+
+# Linting/Formatting
+.ruff_cache/
+.mypy_cache/
+
+# IDE
+.idea/
+.vscode/
+*.swp
+*.swo
+
+# Environment files (never commit secrets)
+.env
+.env.local
+.env.*.local
+
+# Logs
+*.log
+
+# OS files
+.DS_Store
+Thumbs.db
+# Environment files (added by millhouse)
+*.env
+*.env.*
+*.local
+*.secret
+*.secrets
+config.local.*
+.config.local
+*.key
+*.pem
+*.p12
+.aws/credentials
+.ssh/id_*
+
+# Agent tooling (machine-specific, never tracked)
+.claude/
+.lab/
+AGENTS.md
+CLAUDE.md
+

qrdrop-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 itsloopyo
+
+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 OF OR IN CONNECTION WITH
+THE SOFTWARE.

qrdrop-0.1.0/PKG-INFO

@@ -0,0 +1,213 @@
+Metadata-Version: 2.4
+Name: qrdrop
+Version: 0.1.0
+Summary: Instant file sharing from your terminal - share files over LAN with a simple command
+Project-URL: Homepage, https://github.com/itsloopyo/qrdrop
+Project-URL: Documentation, https://github.com/itsloopyo/qrdrop#readme
+Project-URL: Repository, https://github.com/itsloopyo/qrdrop
+Project-URL: Issues, https://github.com/itsloopyo/qrdrop/issues
+Author: itsloopyo
+License-Expression: MIT
+License-File: LICENSE
+Keywords: cli,file-sharing,http,lan,server
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Environment :: Web Environment
+Classifier: Framework :: AsyncIO
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: System Administrators
+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: Topic :: Internet :: WWW/HTTP :: HTTP Servers
+Classifier: Topic :: System :: Networking
+Classifier: Topic :: Utilities
+Requires-Python: >=3.11
+Requires-Dist: aiofiles==25.1.0
+Requires-Dist: anyio==4.13.0
+Requires-Dist: click==8.3.3
+Requires-Dist: colorama==0.4.6; sys_platform == 'win32' or platform_system == 'Windows'
+Requires-Dist: h11==0.16.0
+Requires-Dist: idna==3.15
+Requires-Dist: jinja2==3.1.6
+Requires-Dist: markupsafe==3.0.3
+Requires-Dist: python-multipart==0.0.27
+Requires-Dist: qrcode==8.2
+Requires-Dist: starlette==1.0.1
+Requires-Dist: typing-extensions==4.15.0; python_version < '3.13'
+Requires-Dist: uvicorn==0.46.0
+Provides-Extra: dev
+Requires-Dist: build>=1.0.0; extra == 'dev'
+Requires-Dist: hatchling>=1.25.0; extra == 'dev'
+Requires-Dist: httpx>=0.27.0; extra == 'dev'
+Requires-Dist: pip-audit>=2.7.0; extra == 'dev'
+Requires-Dist: pytest-asyncio>=0.24.0; extra == 'dev'
+Requires-Dist: pytest-cov>=5.0.0; extra == 'dev'
+Requires-Dist: pytest-playwright>=0.5.0; extra == 'dev'
+Requires-Dist: pytest>=8.0.0; extra == 'dev'
+Requires-Dist: ruff>=0.6.0; extra == 'dev'
+Requires-Dist: twine>=5.0.0; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# QRDrop
+
+**Instant file sharing from your terminal.** Serve the current directory over your local network with one command — get a URL, a memorable password, and a QR code your phone can scan in moments.
+
+```bash
+uvx qrdrop
+```
+
+No setup, no fuss, ctrl+c and it's gone.
+
+## Getting Started
+
+Run it without installing anything:
+
+```bash
+uvx qrdrop                                                      # Python 3.11+ via uv
+docker run --rm -p 8000:8000 -v "$PWD:/data" itsloopyo/qrdrop   # no Python at all
+```
+
+Or install it (Python 3.11+):
+
+```bash
+pip install qrdrop
+pipx install qrdrop
+```
+
+See [Docker](#docker) below for port mapping, flags, and image details.
+
+### 1. Share a directory
+
+```bash
+cd ~/photos
+uvx qrdrop
+```
+
+```text
+╭──────────────────────────────────────────────────╮
+│  📂 QRDrop v0.1.0                                │
+╰──────────────────────────────────────────────────╯
+
+  Serving: /home/you/photos
+
+  Local:    http://localhost:8000
+  Network:  http://192.168.1.42:8000
+
+  Password: ember-velvet-canyon
+
+  ┌─ Scan for instant access ─┐
+
+     ▄▄▄▄▄▄▄ ▄    ▄▄▄▄ ▄▄▄▄▄▄▄
+     █ ▄▄▄ █ █▄ ▀█▀  ▀ █ ▄▄▄ █
+     █ ███ █ ▀██ ▄▄▀▄▀ █ ███ █
+     █▄▄▄▄▄█ █▀█ ▄▀█ █ █▄▄▄▄▄█
+     ▄▄  ▄▄▄   █▀  ▀▀   ▄ ▄▄▄▄
+      █▀▀▀ ▄▄█▄▄▄▄█▄██ ▄▄▀█▄▀
+      ▄▀▄▀█▄▄▄▀  ▄ █ ▀▄█ ▀▄██▄
+     ▀▀  ▀▄▄▀▀█▀█ ▀▄██▀ ▄█▄▄▀
+     ▄▄▀█▄▀▄▄▀█▀█   ▄▄▄▄██▄█▀
+     ▄▄▄▄▄▄▄ ▀▀█▄▄█▄ █ ▄ █
+     █ ▄▄▄ █ ██  █ █▀█▄▄▄████
+     █ ███ █  ▄▄█▄  ▀▄▀█▀ ▄▀█▀
+     █▄▄▄▄▄█ █▀▄ ▀▄▀▄  ▄▀▀▀██▄
+
+  └───────────────────────────┘
+
+  Press Ctrl+C to stop the server
+```
+
+If port 8000 is busy, QRDrop automatically picks the next free one.
+
+### 2. Connect from another device
+
+- **Phone**: scan the QR code. It encodes a pre-authenticated link, so you land in the file browser with no typing.
+- **Anything else**: open the network URL and enter the three-word password.
+
+### 3. Browse, view, download
+
+The web UI lets you:
+
+- **Browse** directories with breadcrumb navigation
+- **View** files inline — syntax-highlighted code (Python, Rust, Go, TypeScript, shell, and dozens more), images, and PDFs
+- **Download** any single file, or select several and grab them as one **ZIP, TAR.GZ, or TAR.BZ2** archive
+
+### 4. Allow changes (optional)
+
+QRDrop is **read-only by default**. Opt in to more:
+
+```bash
+qrdrop --upload    # downloads and uploads only
+qrdrop --modify    # downloads, uploads, delete, new folders + rename
+```
+
+## Usage Examples
+
+```bash
+qrdrop --port 9000                  # custom port
+qrdrop --password correct-horse    # bring your own password
+qrdrop --hide-dotfiles              # exclude dotfiles from listings
+qrdrop --bind 192.168.1.42          # bind one interface (default: 0.0.0.0)
+qrdrop --timeout 7200               # expire sessions after 2 hours (default: never)
+qrdrop --quiet                      # no banner, warnings-only logs
+```
+
+Note that QRDrop lists everything by default, including dotfiles. `--hide-dotfiles` is the opt-out.
+
+## CLI Reference
+
+```text
+qrdrop [OPTIONS]
+
+Options:
+  -p, --port PORT      Port to serve on (default: 8000)
+  -b, --bind ADDRESS   Address to bind to (default: 0.0.0.0)
+  --password TEXT      Use specific password instead of generating one
+  --hide-dotfiles      Exclude files starting with '.' from listings
+  --upload             Allow file uploads
+  --modify             Allow uploads, deletions, and directory create/rename (implies --upload)
+  --timeout SECONDS    Expire sessions after this many seconds (default: sessions
+                       last until the server stops)
+  -q, --quiet          Suppress startup banner
+  --version            Show version and exit
+  --help               Show help and exit
+```
+
+## Docker
+
+Images are published to Docker Hub as [`itsloopyo/qrdrop`](https://hub.docker.com/r/itsloopyo/qrdrop) on every release. Mount the directory you want to share at `/data` and forward a port to 8000:
+
+```bash
+docker run --rm -p 8000:8000 -v /path/to/share:/data itsloopyo/qrdrop
+```
+
+The startup banner — including the generated password and QR code — goes to the container logs, so run in the foreground or check `docker logs`. Any `qrdrop` flags can be appended:
+
+```bash
+docker run --rm -p 9000:8000 -v "$PWD:/data" itsloopyo/qrdrop --password correct-horse --modify
+```
+
+The container always listens on port 8000 internally; pick your external port with `-p <port>:8000` rather than `--port`. The QR code and network URL in the banner show the container's internal address — from another device, use your host's IP and the port you published.
+
+The image is multi-stage (uv on Alpine), runs as a non-root user, and has a built-in healthcheck against `/health`. To share read-write (with `--upload` or `--modify`), the mounted directory must be writable by uid 1000.
+
+## Development
+
+The dev loop is [pixi](https://pixi.sh):
+
+```bash
+pixi run build      # editable install with dev extras
+pixi run test       # pytest with coverage
+pixi run test-e2e   # Playwright end-to-end tests
+pixi run lint       # ruff check
+pixi run format     # ruff format
+pixi run dev        # run qrdrop from source
+```
+
+QRDrop is built on Starlette, Uvicorn, Jinja2, and aiofiles.
+
+## License
+
+MIT

qrdrop-0.1.0/README.md

@@ -0,0 +1,160 @@
+# QRDrop
+
+**Instant file sharing from your terminal.** Serve the current directory over your local network with one command — get a URL, a memorable password, and a QR code your phone can scan in moments.
+
+```bash
+uvx qrdrop
+```
+
+No setup, no fuss, ctrl+c and it's gone.
+
+## Getting Started
+
+Run it without installing anything:
+
+```bash
+uvx qrdrop                                                      # Python 3.11+ via uv
+docker run --rm -p 8000:8000 -v "$PWD:/data" itsloopyo/qrdrop   # no Python at all
+```
+
+Or install it (Python 3.11+):
+
+```bash
+pip install qrdrop
+pipx install qrdrop
+```
+
+See [Docker](#docker) below for port mapping, flags, and image details.
+
+### 1. Share a directory
+
+```bash
+cd ~/photos
+uvx qrdrop
+```
+
+```text
+╭──────────────────────────────────────────────────╮
+│  📂 QRDrop v0.1.0                                │
+╰──────────────────────────────────────────────────╯
+
+  Serving: /home/you/photos
+
+  Local:    http://localhost:8000
+  Network:  http://192.168.1.42:8000
+
+  Password: ember-velvet-canyon
+
+  ┌─ Scan for instant access ─┐
+
+     ▄▄▄▄▄▄▄ ▄    ▄▄▄▄ ▄▄▄▄▄▄▄
+     █ ▄▄▄ █ █▄ ▀█▀  ▀ █ ▄▄▄ █
+     █ ███ █ ▀██ ▄▄▀▄▀ █ ███ █
+     █▄▄▄▄▄█ █▀█ ▄▀█ █ █▄▄▄▄▄█
+     ▄▄  ▄▄▄   █▀  ▀▀   ▄ ▄▄▄▄
+      █▀▀▀ ▄▄█▄▄▄▄█▄██ ▄▄▀█▄▀
+      ▄▀▄▀█▄▄▄▀  ▄ █ ▀▄█ ▀▄██▄
+     ▀▀  ▀▄▄▀▀█▀█ ▀▄██▀ ▄█▄▄▀
+     ▄▄▀█▄▀▄▄▀█▀█   ▄▄▄▄██▄█▀
+     ▄▄▄▄▄▄▄ ▀▀█▄▄█▄ █ ▄ █
+     █ ▄▄▄ █ ██  █ █▀█▄▄▄████
+     █ ███ █  ▄▄█▄  ▀▄▀█▀ ▄▀█▀
+     █▄▄▄▄▄█ █▀▄ ▀▄▀▄  ▄▀▀▀██▄
+
+  └───────────────────────────┘
+
+  Press Ctrl+C to stop the server
+```
+
+If port 8000 is busy, QRDrop automatically picks the next free one.
+
+### 2. Connect from another device
+
+- **Phone**: scan the QR code. It encodes a pre-authenticated link, so you land in the file browser with no typing.
+- **Anything else**: open the network URL and enter the three-word password.
+
+### 3. Browse, view, download
+
+The web UI lets you:
+
+- **Browse** directories with breadcrumb navigation
+- **View** files inline — syntax-highlighted code (Python, Rust, Go, TypeScript, shell, and dozens more), images, and PDFs
+- **Download** any single file, or select several and grab them as one **ZIP, TAR.GZ, or TAR.BZ2** archive
+
+### 4. Allow changes (optional)
+
+QRDrop is **read-only by default**. Opt in to more:
+
+```bash
+qrdrop --upload    # downloads and uploads only
+qrdrop --modify    # downloads, uploads, delete, new folders + rename
+```
+
+## Usage Examples
+
+```bash
+qrdrop --port 9000                  # custom port
+qrdrop --password correct-horse    # bring your own password
+qrdrop --hide-dotfiles              # exclude dotfiles from listings
+qrdrop --bind 192.168.1.42          # bind one interface (default: 0.0.0.0)
+qrdrop --timeout 7200               # expire sessions after 2 hours (default: never)
+qrdrop --quiet                      # no banner, warnings-only logs
+```
+
+Note that QRDrop lists everything by default, including dotfiles. `--hide-dotfiles` is the opt-out.
+
+## CLI Reference
+
+```text
+qrdrop [OPTIONS]
+
+Options:
+  -p, --port PORT      Port to serve on (default: 8000)
+  -b, --bind ADDRESS   Address to bind to (default: 0.0.0.0)
+  --password TEXT      Use specific password instead of generating one
+  --hide-dotfiles      Exclude files starting with '.' from listings
+  --upload             Allow file uploads
+  --modify             Allow uploads, deletions, and directory create/rename (implies --upload)
+  --timeout SECONDS    Expire sessions after this many seconds (default: sessions
+                       last until the server stops)
+  -q, --quiet          Suppress startup banner
+  --version            Show version and exit
+  --help               Show help and exit
+```
+
+## Docker
+
+Images are published to Docker Hub as [`itsloopyo/qrdrop`](https://hub.docker.com/r/itsloopyo/qrdrop) on every release. Mount the directory you want to share at `/data` and forward a port to 8000:
+
+```bash
+docker run --rm -p 8000:8000 -v /path/to/share:/data itsloopyo/qrdrop
+```
+
+The startup banner — including the generated password and QR code — goes to the container logs, so run in the foreground or check `docker logs`. Any `qrdrop` flags can be appended:
+
+```bash
+docker run --rm -p 9000:8000 -v "$PWD:/data" itsloopyo/qrdrop --password correct-horse --modify
+```
+
+The container always listens on port 8000 internally; pick your external port with `-p <port>:8000` rather than `--port`. The QR code and network URL in the banner show the container's internal address — from another device, use your host's IP and the port you published.
+
+The image is multi-stage (uv on Alpine), runs as a non-root user, and has a built-in healthcheck against `/health`. To share read-write (with `--upload` or `--modify`), the mounted directory must be writable by uid 1000.
+
+## Development
+
+The dev loop is [pixi](https://pixi.sh):
+
+```bash
+pixi run build      # editable install with dev extras
+pixi run test       # pytest with coverage
+pixi run test-e2e   # Playwright end-to-end tests
+pixi run lint       # ruff check
+pixi run format     # ruff format
+pixi run dev        # run qrdrop from source
+```
+
+QRDrop is built on Starlette, Uvicorn, Jinja2, and aiofiles.
+
+## License
+
+MIT

qrdrop-0.1.0/pyproject.toml

@@ -0,0 +1,129 @@
+[project]
+name = "qrdrop"
+version = "0.1.0"
+description = "Instant file sharing from your terminal - share files over LAN with a simple command"
+readme = "README.md"
+license = "MIT"
+requires-python = ">=3.11"
+authors = [
+    { name = "itsloopyo" }
+]
+keywords = ["file-sharing", "lan", "http", "server", "cli"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Environment :: Console",
+    "Environment :: Web Environment",
+    "Framework :: AsyncIO",
+    "Intended Audience :: Developers",
+    "Intended Audience :: System Administrators",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Topic :: Internet :: WWW/HTTP :: HTTP Servers",
+    "Topic :: System :: Networking",
+    "Topic :: Utilities",
+]
+# The FULL transitive closure is pinned ==, deliberately: qrdrop is an
+# application installed via `uvx qrdrop`/`pip install qrdrop`, so end users
+# resolve from this metadata at install time. Exact pins mean they get the
+# versions we tested, not whatever was published this morning - a hijacked
+# dependency release cannot reach users without a new qrdrop release.
+# Bump via `pixi run lock` (enforces the two-week release cooldown), retest,
+# release.
+dependencies = [
+    "starlette==1.0.1",
+    "uvicorn==0.46.0",
+    "jinja2==3.1.6",
+    "qrcode==8.2",
+    "python-multipart==0.0.27",
+    "aiofiles==25.1.0",
+    # Transitive
+    "anyio==4.13.0",
+    "click==8.3.3",
+    "colorama==0.4.6; sys_platform == 'win32' or platform_system == 'Windows'",
+    "h11==0.16.0",
+    "idna==3.15",
+    "markupsafe==3.0.3",
+    "typing-extensions==4.15.0; python_version < '3.13'",
+]
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=8.0.0",
+    "pytest-asyncio>=0.24.0",
+    "pytest-cov>=5.0.0",
+    "ruff>=0.6.0",
+    "httpx>=0.27.0",
+    "pytest-playwright>=0.5.0",
+    "build>=1.0.0",
+    "twine>=5.0.0",
+    "hatchling>=1.25.0",
+    "pip-audit>=2.7.0",
+]
+
+[project.scripts]
+qrdrop = "qrdrop.__main__:main"
+
+[project.urls]
+Homepage = "https://github.com/itsloopyo/qrdrop"
+Documentation = "https://github.com/itsloopyo/qrdrop#readme"
+Repository = "https://github.com/itsloopyo/qrdrop"
+Issues = "https://github.com/itsloopyo/qrdrop/issues"
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/qrdrop"]
+
+[tool.hatch.build.targets.sdist]
+include = [
+    "/src",
+    "/tests",
+    "/README.md",
+    "/LICENSE",
+]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+asyncio_mode = "auto"
+asyncio_default_fixture_loop_scope = "function"
+
+[tool.coverage.run]
+source = ["src/qrdrop"]
+branch = true
+
+[tool.coverage.report]
+exclude_lines = [
+    "pragma: no cover",
+    "if __name__ == .__main__.:",
+    "if TYPE_CHECKING:",
+]
+
+[tool.ruff]
+target-version = "py311"
+line-length = 100
+src = ["src", "tests"]
+
+[tool.ruff.lint]
+select = [
+    "E",      # pycodestyle errors
+    "W",      # pycodestyle warnings
+    "F",      # Pyflakes
+    "I",      # isort
+    "B",      # flake8-bugbear
+    "C4",     # flake8-comprehensions
+    "UP",     # pyupgrade
+    "ARG",    # flake8-unused-arguments
+    "SIM",    # flake8-simplify
+]
+ignore = [
+    "E501",   # line too long (handled by formatter)
+    "B008",   # do not perform function calls in argument defaults
+]
+
+[tool.ruff.lint.isort]
+known-first-party = ["qrdrop"]

qrdrop-0.1.0/src/qrdrop/__init__.py

@@ -0,0 +1,3 @@
+"""QRDrop - Instant file sharing from your terminal."""
+
+__version__ = "0.1.0"

qrdrop-0.1.0/src/qrdrop/__main__.py

@@ -0,0 +1,6 @@
+"""Entry point for uvx/python -m qrdrop."""
+
+from qrdrop.cli import main
+
+if __name__ == "__main__":
+    main()