Open Storefront is distributed as a single Python script that you can run directly from the cloned repository, or as a standalone binary compiled with PyInstaller for machines that do not have Python installed. Both methods are described below. Choose the one that best fits your environment.Documentation Index
Fetch the complete documentation index at: https://mintlify.com/drake-rochelle/open-storefront/llms.txt
Use this file to discover all available pages before exploring further.
Installation Methods
- Run from Source
- Pre-built Binary
Running from source is the simplest approach and works on any machine with Python 3 installed. No build step is required.1. Clone the repositoryIf you prefer not to use Git, download the ZIP archive from github.com/drake-rochelle/open-storefront and extract it to a folder of your choice.2. Launch the clientOn some systems the Python 3 interpreter is invoked as The client will print your download path, fetch the home storefront from Google Drive, and display the interactive menu. No further setup is needed.
python3:System Requirements
| Requirement | Details |
|---|---|
| Python version | Python 3.x (any recent 3.x release). Not required when using a pre-built binary. |
| Operating system | Windows, macOS, or Linux |
| Internet connection | Required at runtime to fetch storefront.json manifests from Google Drive |
| Disk space | Negligible for the script itself; varies based on content you download |
Optional Configuration Files
These files are not required but let you customise the client’s behaviour. Place them in the same directory asmain.py (or the compiled binary).
| File | Purpose |
|---|---|
download_path.txt | Override the default download location (your home directory). Paste the absolute path to your preferred folder on a single line. The placeholder value C:/Path/To/Custom/Download/Folder is ignored. |
home.3sf | Override the default home storefront. Paste a Google Drive file ID on a single line to use a different storefront as your starting point. |
input | Pre-recorded input file for automation. Each line is replayed as a keystroke. |
No
pip install step is ever needed. Open Storefront uses only Python standard library modules: urllib.request, json, os, platform, pathlib, and sys. If Python 3 is installed, you can run the script immediately after cloning — nothing else is required.Troubleshooting
'python' is not recognized as a command (Windows)
'python' is not recognized as a command (Windows)
Python has not been added to your system
PATH. The quickest fix is to re-run the Python installer, check “Add Python to PATH” on the first screen, and then open a new terminal window.Alternatively, add the Python installation directory (e.g. C:\Users\YourName\AppData\Local\Programs\Python\Python3x\) and its Scripts sub-folder to your PATH environment variable manually via System Properties → Environment Variables.On macOS and Linux the interpreter is usually available as python3 — try that if python is not found.storefront.json not found or menu does not appear
storefront.json not found or menu does not appear
Files are downloading to the wrong location
Files are downloading to the wrong location
By default, all files are saved under your home directory (Make sure the value is not the placeholder
~), organised into sub-folders defined by the storefront manifest. To change this, create a download_path.txt file in the same directory as main.py and write the full absolute path to your preferred download folder on a single line — for example:C:/Path/To/Custom/Download/Folder, which the client ignores.