Skip to content

Installation

Requirements

  • Python 3.10 or later
  • Linux, macOS, or Windows (WSL recommended)

Install from Source

git clone https://github.com/nft2-me/PikoClaw.git
cd PikoClaw
pip install -e .

Optional: Graph Analysis

For communication network intelligence (HITS, PageRank, Louvain communities):

pip install -e ".[graph]"

This adds networkx, numpy, and scipy. Without these, PikoClaw works normally but skips network analysis output.

Optional: Development

pip install -e ".[dev]"
pytest

PST/OST Support

PST and OST parsing requires libpff-python:

pip install libpff-python
System dependencies for libpff-python

Ubuntu/Debian:

sudo apt-get install build-essential python3-dev
pip install libpff-python

macOS:

brew install libpff
pip install libpff-python

Windows: Use WSL (Windows Subsystem for Linux) for the best experience.

No pypff? No problem

PikoClaw works without libpff-python for Maildir and MBOX formats. PST/OST support is the only feature that requires it.

Verify Installation

pikoclaw --help

You should see:

usage: pikoclaw [-h] {extract} ...

Extract institutional knowledge from email archives (PST/OST, Maildir, MBOX).

positional arguments:
  {extract}
    extract   Extract knowledge from email archive(s)