Documentation navigation

Install Reputation Monitor

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.

Purpose

Install the local project in an isolated Python environment and verify that its reputation-monitor command is available.

Before you begin

  • Confirm the system requirements.
  • Open a terminal in the project root—the directory containing pyproject.toml.
  • Use Python 3.11 or newer.

macOS and Linux

  1. Create a virtual environment:

``bash python3.11 -m venv .venv ``

  1. Activate it:

``bash source .venv/bin/activate ``

  1. Upgrade pip:

``bash python -m pip install --upgrade pip ``

  1. Install the project with its development dependency:

``bash python -m pip install ".[dev]" ``

  1. Verify the installed command:

``bash reputation-monitor --help ``

Windows PowerShell

  1. Create the environment:

``powershell py -3.11 -m venv .venv ``

  1. Activate it:

``powershell .venv\Scripts\Activate.ps1 ``

  1. Install the project and test dependency:

``powershell python -m pip install --upgrade pip python -m pip install ".[dev]" ``

  1. Verify the command:

``powershell reputation-monitor --help ``

If PowerShell blocks activation, use the execution-policy procedure approved for your environment. Do not replace the local environment with an administrator-level global installation.

Expected verification output

The help output begins with syntax similar to:

usage: reputation-monitor [-h] [--previous PREVIOUS] [--current CURRENT]
                          [--output-dir OUTPUT_DIR] [--maximum-rating 1-5]

It then describes the four supported options. See the CLI reference for their exact behavior.

What the project installation includes

The quoted ".[dev]" installs the package, its runtime dependencies, and the dev extra containing pytest. Reinstall after changing source code when validating the installed command.

Verify the Streamlit command as well as the CLI:

streamlit version

Common installation problems

Symptom Check Resolution
Python command not found Run python3.11 --version or py -3.11 --version. Install a supported Python release and reopen the terminal.
reputation-monitor not found Run python -m pip show reputation-monitor. Activate .venv and repeat the project install.
No module named pytest Run python -m pip show pytest. Install with python -m pip install ".[dev]".
Permission error Check whether .venv is active. Install inside the local environment without sudo.
Project cannot build Check the complete pip output. Confirm network access for build requirements and use a current pip.

Next step

Run the supplied dataset with the quickstart.