Project Structure

🗂 Project Structure

This page describes the file and folder structure of the VirusTotal File Scanner and explains the purpose of each key component.

---

📁 Recommended Repository Layout

VirusTotal-File-Scanner/
├── app.py                        # Main application logic (encrypted)
├── cli_scan.py                  # Optional CLI entry point (if available)
├── config.py                    # Configuration file (user-editable)
├── .env                         # Optional environment file (not committed)
├── requirements.txt             # Python dependencies
├── verify_runtime.py            # Optional Runtime check helper
├── README.md                    # Project description
├── LICENSE                      # MIT license file

├── pyarmor_runtime_000000/      # PyArmor runtime (must not be changed)
│   ├── __init__.py
│   └── pyarmor_runtime.pyd

├── exports/                     # Exported scan reports (JSON/CSV)
│   └── ...                      # Results saved from the app

├── logs/                        # Optional log output
│   └── scanner.log

└── wiki/                        # Markdown-based wiki (optional)
    └── en/

---

📄 File Descriptions

app.py

The core logic of the GUI – encrypted using PyArmor. Do not edit or decrypt.

config.py / .env

User configuration: API key, language, export format, logging options.

cli_scan.py

Optional command-line entry point for automated scans (if included).

requirements.txt

All Python dependencies needed to run the app.

pyarmor_runtime_000000/

Contains the native loader (pyarmor_runtime.pyd) needed to run encrypted code.

verify_runtime.py

Helper script that checks whether the PyArmor runtime is present and functional.

---

📂 Output Folders

• /exports/ → All scan results exported via GUI (CSV/JSON)
• /logs/ → Optional scan logs (if enabled in config.py)

---

📚 Notes

• Never commit config.py with a real API key.
• pyarmor_runtime.pyd must be included when distributing.
• Avoid modifying files in the runtime folder.