Skip to content

Installation

ScoutML can be installed via pip or from source, providing both a command-line interface and a Python library.

Requirements

  • Python 3.8 or higher
  • pip package manager

Install from PyPI

The easiest way to install ScoutML is via pip:

pip install scoutml

This installs both the CLI tool and the Python library.

Install from Source

For the latest development version or to contribute:

git clone https://github.com/prospectml/scoutml
cd scoutml
pip install -e .

Development Installation

Using pip install -e . installs the package in "editable" mode, allowing you to modify the code and see changes immediately without reinstalling.

Verify Installation

After installation, verify ScoutML is working:

CLI Verification

scoutml --version

You should see the version number displayed.

Python Library Verification

import scoutml
print(scoutml.__version__)

# Test API access (requires API key)
try:
    results = scoutml.search("test", limit=1)
    print("✓ ScoutML is working correctly")
except Exception as e:
    print(f"✗ Error: {e}")

Dependencies

ScoutML automatically installs these dependencies:

  • click - Command-line interface framework
  • requests - HTTP library for API calls
  • rich - Terminal formatting and tables
  • python-dotenv - Environment variable management
  • tabulate - Table formatting
  • tqdm - Progress bars

Troubleshooting

Permission Errors

If you encounter permission errors during installation:

pip install --user scoutml

Virtual Environments

We recommend using a virtual environment:

python -m venv scoutml-env
source scoutml-env/bin/activate  # On Windows: scoutml-env\Scripts\activate
pip install scoutml

conda create -n scoutml python=3.11
conda activate scoutml
pip install scoutml

Upgrading

To upgrade to the latest version:

pip install --upgrade scoutml

Next Steps

After installation, you'll need to configure your API key to start using ScoutML.