Installation¶
Requirements¶
- Python 3.9 or newer.
pip(bundled with Python 3.9+).- A network interface that is up (Wi-Fi or Ethernet) — used to advertise the URL.
Install from PyPI¶
pip install qrtransfer-lite
This installs the qrtransfer console command, plus its three runtime
dependencies: platformdirs, psutil, and qrcode-terminal.
You can also run it without installing into your system site-packages:
python -m qrtransfer --help
Optional extras¶
| Extra | Installs | Enables |
|---|---|---|
[clipboard] |
pyperclip |
--clipboard (copy the URL to the clipboard) |
[tls] |
cryptography |
Auto-generating a self-signed certificate with --tls |
pip install "qrtransfer-lite[clipboard]"
pip install "qrtransfer-lite[tls]"
pip install "qrtransfer-lite[clipboard,tls]"
--tls still works without the tls extra if you pass your own certificate with
--cert and --key; auto-generation needs cryptography.
Install in a virtual environment (recommended)¶
python -m venv .venv
source .venv/bin/activate # Linux / macOS
# .venv\Scripts\activate.bat # Windows cmd
# .venv\Scripts\Activate.ps1 # Windows PowerShell
pip install qrtransfer-lite
Install from source¶
git clone https://github.com/rkriad585/qrtransfer.git
cd qrtransfer
python -m venv .venv
source .venv/bin/activate # Windows: .venv\Scripts\activate
pip install -e ".[dev]"
.[dev] installs the package plus the developer tooling (pytest, ruff,
pyright, build). For the docs tooling use .[docs] instead — this is what the
GitHub Pages workflow installs (see deployment).
Verify¶
qrtransfer --version
qrtransfer --help