Table of Contents

1. Introduction to hepc – HTTP End Point for CodeQL

1.1. Usage Sample

1:$ ./bin/hepc-init --db_collection_dir db-collection --starting_path ~/work-gh/mrva/mrva-open-source-download
[2024-11-19 14:12:06] [INFO] searching for db.zip files
[2024-11-19 14:12:08] [INFO] collecting information from db.zip files
[2024-11-19 14:12:08] [INFO] Extracting from /Users/hohn/work-gh/mrva/mrva-open-source-download/repos/aircrack-ng/aircrack-ng/code-scanning/codeql/databases/cpp/db.zip
[2024-11-19 14:12:08] [INFO] Adding record to db-collection/metadata.json

1.2. Installation

  • Set up the virtual environment and install tools

    cd ~/work-gh/mrva/mrvahepc
    python3.11 -m venv venv
    source venv/bin/activate
    pip install --upgrade pip
    
    # From requirements.txt
    pip install -r requirements.txt
    # Or explicitly
    pip install ipython
    
  • Local development

    cd ~/work-gh/mrva/mrvahepc
    source venv/bin/activate
    pip install --editable .
    

    The `–editable` should use symlinks for all scripts; use `./bin/*` to be sure.

  • Full installation

    pip install mrvahepc
    

1.3. Use as library

The best way to examine the code is starting from the high-level scripts in bin/.

Author: Michael Hohn

Created: 2024-12-17 Tue 20:54

Validate