Documentation navigation

System requirements

Application version: 1.0.0Documentation version: 1.0.1Last technical review: 2026-10-17View Source Code on GitHub →

Written by Elena David, SEO, ORM, and AI Visibility Consultant.

Use this reference before installing Reputation Monitor 1.0.

Runtime requirements

Requirement Supported value Why it is needed
Python 3.11 or newer Declared by requires-python = ">=3.11" in pyproject.toml.
pip A version compatible with the selected Python installation Installs the local package and optional test dependency.
Terminal macOS/Linux shell or Windows PowerShell Creates the environment and runs the CLI.
File access Read access to inputs and write access to the output directory Required to read snapshots and create reports.
Browser Any current browser Operates Streamlit and opens standalone HTML reports.
Network Required only for package installation and authorized website imports The CSV and CLI workflows otherwise run locally.

Check the active interpreter:

python3.11 --version

The command should report Python 3.11 or a later release. After the virtual environment is active, use:

python --version

Dependencies

The core validation, analysis, CLI, and report logic uses Python standard-library modules, including:

  • argparse for CLI arguments;
  • csv for input and alert output;
  • dataclasses for structured records;
  • datetime for dates and report timestamps;
  • html for escaping report content;
  • pathlib for filesystem paths;
  • sys for warning and error output.

The dashboard and website importer add three declared runtime dependencies: Streamlit, Requests, and Beautiful Soup. Development and test installation adds pytest>=8,<9. Setuptools 68 or newer is declared as the build backend requirement.

Operating-system considerations

The Python code uses cross-platform standard-library APIs. The installation and file-opening commands differ by operating system:

Task macOS/Linux Windows PowerShell
Create environment python3.11 -m venv .venv py -3.11 -m venv .venv
Activate environment source .venv/bin/activate .venv\Scripts\Activate.ps1
Open HTML report open ... on macOS, xdg-open ... where available on Linux Start-Process ...

The automated tests verify application behavior rather than every operating-system shell command. Paths supplied through the CLI are converted to pathlib.Path objects.

Input and storage requirements

Input snapshots must be readable CSV files. The loader opens them with utf-8-sig, which accepts UTF-8 content with or without a byte-order mark. Each file must include the required header names described in Preparing reputation data.

Reports are small for the bundled sample data. The application loads validated records into memory, so memory use grows with input size. Version 1.0 does not stream analysis or define a tested maximum CSV dataset size. Website imports are limited to 2 MB of HTML.

Installation verification checklist

Before continuing, confirm that:

  • python3.11 --version or py -3.11 --version succeeds;
  • the project contains pyproject.toml;
  • the terminal can read the data/ directory;
  • the current user can create files in the intended report directory;
  • network access is available if pip must download packages;
  • a current browser is available for Streamlit;
  • website import is used only for public pages that the operator is authorized to process.

Continue to the installation guide.