Skip to content

INSTALLATION.md

Latest commit

 

History

History
73 lines (52 loc) · 1.47 KB

INSTALLATION.md

File metadata and controls

73 lines (52 loc) · 1.47 KB

Installation

Requirements

  • Python 3.10 or higher
  • requests (only hard dependency)

PyPI (recommended)

pip install huntertrace

With optional enrichment features (WHOIS, graph centrality):

pip install huntertrace[full]

From source

git clone https://github.com/YOUR_ORG/huntertrace
cd huntertrace-release
pip install -e ".[full]"

Development install (includes linting and test tools):

pip install -e ".[dev]"

Verify installation

huntertrace info

Expected output:

HunterTrace v3.0.0

Package modules:
  ✓  core.pipeline
  ✓  extraction.webmail
  ...

Optional dependencies:
  ✓  installed  requests     live IP enrichment
  –  not installed  networkx     graph centrality analysis
  –  not installed  whois        WHOIS enrichment (Stage 3B)

API Keys (optional)

HunterTrace works without any API keys. Keys enable additional enrichment:

Key Service How to get
ABUSEIPDB_API_KEY AbuseIPDB Free tier: 1000 req/day
VIRUSTOTAL_API_KEY VirusTotal Free tier: 4 req/min
IPINFO_TOKEN ipinfo.io Free tier: 50k req/month

Set via environment variable or .env file in working directory:

# Environment
export ABUSEIPDB_API_KEY=your_key_here

# .env file (auto-loaded)
echo "ABUSEIPDB_API_KEY=your_key_here" >> .env