exeplot 0.5.2__tar.gz → 0.5.5__tar.gz

exeplot-0.5.5/.github/dependabot.yml

@@ -0,0 +1,15 @@
+version: 2
+updates:
+  - package-ecosystem: github-actions
+    directory: /
+    schedule:
+      interval: monthly
+    groups:
+      actions:
+        patterns: ["*"]
+  - package-ecosystem: pip
+    directory: /
+    schedule:
+      interval: monthly
+    # dependencies are minimum versions (>=) ; only open security updates, not routine upgrades
+    open-pull-requests-limit: 0

exeplot-0.5.5/.github/workflows/python-package.yml

@@ -0,0 +1,142 @@
+# This workflow will install Python dependencies, run tests and lint with a variety of Python versions
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python
+
+name: build
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+permissions:
+  contents: read
+
+jobs:
+  prepare:
+    runs-on: ubuntu-latest
+    outputs:
+      package: ${{ steps.pkg.outputs.package }}
+      pypi_url: ${{ steps.pkg.outputs.pypi_url }}
+    steps:
+      - name: Compute package name from the repository's
+        id: pkg
+        run: |
+          name="${GITHUB_REPOSITORY##*/}"
+          echo "package=${name#python-}" >> $GITHUB_OUTPUT
+          echo "pypi_url=https://pypi.org/p/${name#python-}" >> $GITHUB_OUTPUT
+  build:
+    needs: prepare
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest]
+        python-version: ["3.10", "3.11", "3.12", "3.13"]
+    env:
+      package: ${{ needs.prepare.outputs.package }}
+      cov_python_version: "3.13"
+    steps:
+    - uses: actions/checkout@v5
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v6
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install ${{ env.package }}
+      run: |
+        sudo apt-get update
+        sudo apt-get install -y graphviz libgraphviz-dev
+        python -m pip install --upgrade pip
+        python -m pip install pytest pytest-cov
+        pip install -r requirements.txt
+        pip install .
+    - name: Test ${{ env.package }} with pytest
+      run: |
+        pytest --cov=$package --cov-report=xml
+    - name: Upload coverage report
+      if: matrix.python-version == env.cov_python_version
+      uses: actions/upload-artifact@v7
+      with:
+        name: coverage-report
+        path: coverage.xml
+  coverage:
+    # only publish the badge for commits on main (not for pull requests)
+    if: github.event_name == 'push' && github.ref == 'refs/heads/main'
+    needs: build
+    permissions:
+      contents: write
+    runs-on: ubuntu-latest
+    env:
+      cov_badge_path: docs/coverage.svg
+    steps:
+    - uses: actions/checkout@v5
+    - name: Set up Python
+      uses: actions/setup-python@v6
+      with:
+        python-version: "3.13"
+    - name: Download coverage report
+      uses: actions/download-artifact@v8
+      with:
+        name: coverage-report
+    - name: Make coverage badge
+      run: |
+        pip install genbadge[coverage]
+        genbadge coverage -i coverage.xml -o $cov_badge_path
+    - name: Push coverage badge
+      run: |
+        # keep the badge alone on an orphan branch so that main is never modified by the workflow
+        git config --local user.email "github-actions[bot]@users.noreply.github.com"
+        git config --local user.name "github-actions[bot]"
+        if git fetch --depth=1 origin coverage-badge 2>/dev/null && \
+           git show FETCH_HEAD:$cov_badge_path | cmp -s - $cov_badge_path; then
+          echo "Coverage badge unchanged"
+          exit 0
+        fi
+        git checkout --orphan coverage-badge
+        git rm -rqf --cached .
+        git add $cov_badge_path
+        git commit -m "Update coverage badge"
+        git push origin coverage-badge --force
+  deploy:
+    # only release from main, never from pull requests
+    if: github.event_name == 'push' && github.ref == 'refs/heads/main'
+    environment:
+      name: pypi
+      url: ${{ needs.prepare.outputs.pypi_url }}
+    permissions:
+      contents: read
+      id-token: write  # for PyPI trusted publishing (OIDC)
+    runs-on: ubuntu-latest
+    needs: [prepare, build]
+    env:
+      package: ${{ needs.prepare.outputs.package }}
+    steps:
+    - uses: actions/checkout@v5
+    - name: Check whether the version is already on PyPI
+      # comparing with PyPI (not with the previous commit) also releases a version whose push did not trigger a deploy
+      id: version
+      run: |
+        version=$(tr -d '[:space:]' < src/$package/VERSION.txt)
+        status=$(curl -s -o /dev/null -w '%{http_code}' --retry 3 "https://pypi.org/pypi/$package/$version/json")
+        case "$status" in
+          200) echo "Version $version is already on PyPI" ; echo "new=false" >> "$GITHUB_OUTPUT" ;;
+          404) echo "Version $version is not on PyPI yet" ; echo "new=true" >> "$GITHUB_OUTPUT" ;;
+          *)   echo "::error::Unexpected HTTP status $status from PyPI" ; exit 1 ;;
+        esac
+    - if: steps.version.outputs.new == 'true'
+      name: Set up Python
+      uses: actions/setup-python@v6
+      with:
+        python-version: "3.13"
+    - if: steps.version.outputs.new == 'true'
+      name: Cleanup README
+      run: |
+        sed -ri 's/^(##*)\s*:.*:\s*/\1 /g' README.md
+        awk '{if (match($0,"## Supporters")) exit; print}' README.md > README
+        mv -f README README.md
+    - if: steps.version.outputs.new == 'true'
+      name: Build ${{ needs.prepare.outputs.package }} package
+      run: python -m pip install --upgrade build && python -m build
+    - if: steps.version.outputs.new == 'true'
+      name: Publish to PyPI
+      uses: pypa/gh-action-pypi-publish@release/v1

exeplot-0.5.5/.github/workflows/security.yml

@@ -0,0 +1,31 @@
+# This workflow audits the package dependencies for known vulnerabilities
+# It is separate from python-package.yml so that a new advisory never blocks a release
+
+name: security
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+  schedule:
+    - cron: "0 6 * * 1"  # weekly, catches new advisories between pushes
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+jobs:
+  pip-audit:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v7
+    - name: Set up Python
+      uses: actions/setup-python@v7
+      with:
+        python-version: "3.13"
+    - name: Install pip-audit
+      run: python -m pip install --upgrade pip pip-audit
+    - name: Audit dependencies
+      # resolves the dependencies of pyproject.toml in an isolated environment, so only these are audited
+      run: pip-audit .

exeplot-0.5.2/.readthedocs.yml → exeplot-0.5.5/.readthedocs.yaml

@@ -1,7 +1,7 @@
 version: 2
 
 build:
-  os: "ubuntu-24.04"
+  os: ubuntu-24.04
   tools:
     python: "3.13"
 

{exeplot-0.5.2 → exeplot-0.5.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: exeplot
-Version: 0.5.2
+Version: 0.5.5
 Summary: Library for plotting executable samples supporting multiple formats
 Author-email: Alexandre D'Hondt <alexandre.dhondt@gmail.com>
 License:                     GNU GENERAL PUBLIC LICENSE
@@ -696,22 +696,25 @@ Requires-Dist: lief>=0.16.1
 Requires-Dist: matplotlib
 Provides-Extra: graph
 Requires-Dist: angr>=9.2; extra == "graph"
+Requires-Dist: bitstring<5; python_version < "3.12" and extra == "graph"
+Requires-Dist: pycparser<3.12; python_version < "3.12" and extra == "graph"
 Requires-Dist: networkx>=3.4.2; extra == "graph"
 Requires-Dist: numpy; extra == "graph"
 Requires-Dist: pygraphviz>=1.14; extra == "graph"
+Requires-Dist: scipy; extra == "graph"
 Requires-Dist: unicorn>2; extra == "graph"
 Dynamic: license-file
 
 <p align="center" id="top"><img src="https://github.com/packing-box/python-exeplot/raw/main/docs/pages/img/logo.png"></p>
 <h1 align="center">ExePlot <a href="https://twitter.com/intent/tweet?text=ExePlot%20-%20Plot%20executable%20samples%20easy.%0D%0ALibrary%20for%20plotting%20executable%20samples%20supporting%20multiple%20formats.%0D%0Ahttps%3a%2f%2fgithub%2ecom%2fpacking-box%2fpython-exeplot%0D%0A&hashtags=python,programming,executable-samples,plot"><img src="https://img.shields.io/badge/Tweet--lightgrey?logo=twitter&style=social" alt="Tweet" height="20"/></a></h1>
-<h3 align="center">Search for samples from various malware databases.</h3>
+<h3 align="center">Plot executable samples easy.</h3>
 
 [![PyPi](https://img.shields.io/pypi/v/exeplot.svg)](https://pypi.python.org/pypi/exeplot/)
 [![Read The Docs](https://readthedocs.org/projects/python-exeplot/badge/?version=latest)](https://python-exeplot.readthedocs.io/en/latest/?badge=latest)
 [![Build Status](https://github.com/packing-box/python-exeplot/actions/workflows/python-package.yml/badge.svg)](https://github.com/packing-box/python-exeplot/actions/workflows/python-package.yml)
-[![Coverage Status](https://raw.githubusercontent.com/packing-box/python-exeplot/main/docs/coverage.svg)](#)
+[![Security](https://github.com/packing-box/python-exeplot/actions/workflows/security.yml/badge.svg)](https://github.com/packing-box/python-exeplot/actions/workflows/security.yml)
+[![Coverage Status](https://raw.githubusercontent.com/packing-box/python-exeplot/coverage-badge/docs/coverage.svg)](#)
 [![Python Versions](https://img.shields.io/pypi/pyversions/exeplot.svg)](https://pypi.python.org/pypi/exeplot/)
-[![Known Vulnerabilities](https://snyk.io/test/github/packing-box/python-exeplot/badge.svg?targetFile=requirements.txt)](https://snyk.io/test/github/packing-box/python-exeplot?targetFile=requirements.txt)
 [![License](https://img.shields.io/pypi/l/exeplot.svg)](https://pypi.python.org/pypi/exeplot/)
 
 This library implements multiple plot types for illustrating executable samples. It currently supports the PE, ELF and Mach-O formats, relying on [`lief`](https://github.com/lief-project/LIEF) for abstracting them.
@@ -771,3 +774,4 @@ $ exeplot entropy calc_packed.exe --no-title --no-legend --no-label --no-entrypo
 ![Simplified entropy plot of `calc_packed.exe`](https://github.com/packing-box/python-exeplot/blob/main/docs/pages/img/calc_packed_entropy.png?raw=true)
 
 
+<p align="center"><a href="#top"><img src="https://img.shields.io/badge/Back%20to%20top--lightgrey?style=social" alt="Back to top" height="20"/></a></p>

{exeplot-0.5.2 → exeplot-0.5.5}/README.md

@@ -1,13 +1,13 @@
 <p align="center" id="top"><img src="https://github.com/packing-box/python-exeplot/raw/main/docs/pages/img/logo.png"></p>
 <h1 align="center">ExePlot <a href="https://twitter.com/intent/tweet?text=ExePlot%20-%20Plot%20executable%20samples%20easy.%0D%0ALibrary%20for%20plotting%20executable%20samples%20supporting%20multiple%20formats.%0D%0Ahttps%3a%2f%2fgithub%2ecom%2fpacking-box%2fpython-exeplot%0D%0A&hashtags=python,programming,executable-samples,plot"><img src="https://img.shields.io/badge/Tweet--lightgrey?logo=twitter&style=social" alt="Tweet" height="20"/></a></h1>
-<h3 align="center">Search for samples from various malware databases.</h3>
+<h3 align="center">Plot executable samples easy.</h3>
 
 [![PyPi](https://img.shields.io/pypi/v/exeplot.svg)](https://pypi.python.org/pypi/exeplot/)
 [![Read The Docs](https://readthedocs.org/projects/python-exeplot/badge/?version=latest)](https://python-exeplot.readthedocs.io/en/latest/?badge=latest)
 [![Build Status](https://github.com/packing-box/python-exeplot/actions/workflows/python-package.yml/badge.svg)](https://github.com/packing-box/python-exeplot/actions/workflows/python-package.yml)
-[![Coverage Status](https://raw.githubusercontent.com/packing-box/python-exeplot/main/docs/coverage.svg)](#)
+[![Security](https://github.com/packing-box/python-exeplot/actions/workflows/security.yml/badge.svg)](https://github.com/packing-box/python-exeplot/actions/workflows/security.yml)
+[![Coverage Status](https://raw.githubusercontent.com/packing-box/python-exeplot/coverage-badge/docs/coverage.svg)](#)
 [![Python Versions](https://img.shields.io/pypi/pyversions/exeplot.svg)](https://pypi.python.org/pypi/exeplot/)
-[![Known Vulnerabilities](https://snyk.io/test/github/packing-box/python-exeplot/badge.svg?targetFile=requirements.txt)](https://snyk.io/test/github/packing-box/python-exeplot?targetFile=requirements.txt)
 [![License](https://img.shields.io/pypi/l/exeplot.svg)](https://pypi.python.org/pypi/exeplot/)
 
 This library implements multiple plot types for illustrating executable samples. It currently supports the PE, ELF and Mach-O formats, relying on [`lief`](https://github.com/lief-project/LIEF) for abstracting them.
@@ -67,3 +67,4 @@ $ exeplot entropy calc_packed.exe --no-title --no-legend --no-label --no-entrypo
 ![Simplified entropy plot of `calc_packed.exe`](https://github.com/packing-box/python-exeplot/blob/main/docs/pages/img/calc_packed_entropy.png?raw=true)
 
 
+<p align="center"><a href="#top"><img src="https://img.shields.io/badge/Back%20to%20top--lightgrey?style=social" alt="Back to top" height="20"/></a></p>

exeplot-0.5.5/SECURITY.md

@@ -0,0 +1,17 @@
+# Security Policy
+
+## Supported Versions
+
+Only the latest release of ExePlot (`exeplot` on [PyPI](https://pypi.org/project/exeplot/)) receives security fixes.
+
+## Reporting a Vulnerability
+
+Please do **not** report security vulnerabilities through public GitHub issues.
+
+Instead, report them privately through [GitHub's private vulnerability reporting](https://github.com/packing-box/python-exeplot/security/advisories/new) (the repository's *Security* tab, then *Report a vulnerability*). Please include:
+
+- the ExePlot version (`exeplot --help` prints it);
+- the steps to reproduce the issue, and a sample (or its hash) if relevant;
+- the impact you expect.
+
+You will get an answer as soon as possible. Once the issue is confirmed, a fix is released and the advisory is published.

{exeplot-0.5.2 → exeplot-0.5.5}/docs/coverage.svg

@@ -1 +1 @@
-<svg xmlns="http://www.w3.org/2000/svg" width="114" height="20" role="img" aria-label="coverage: 96.54%"><title>coverage: 96.54%</title><linearGradient id="s" x2="0" y2="100%"><stop offset="0" stop-color="#bbb" stop-opacity=".1"/><stop offset="1" stop-opacity=".1"/></linearGradient><clipPath id="r"><rect width="114" height="20" rx="3" fill="#fff"/></clipPath><g clip-path="url(#r)"><rect width="61" height="20" fill="#555"/><rect x="61" width="53" height="20" fill="#4c1"/><rect width="114" height="20" fill="url(#s)"/></g><g fill="#fff" text-anchor="middle" font-family="Verdana,Geneva,DejaVu Sans,sans-serif" text-rendering="geometricPrecision" font-size="110"><text aria-hidden="true" x="315" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="510">coverage</text><text x="315" y="140" transform="scale(.1)" fill="#fff" textLength="510">coverage</text><text aria-hidden="true" x="865" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="430">96.54%</text><text x="865" y="140" transform="scale(.1)" fill="#fff" textLength="430">96.54%</text></g></svg>
+<svg xmlns="http://www.w3.org/2000/svg" width="114" height="20" role="img" aria-label="coverage: 96.64%"><title>coverage: 96.64%</title><linearGradient id="s" x2="0" y2="100%"><stop offset="0" stop-color="#bbb" stop-opacity=".1"/><stop offset="1" stop-opacity=".1"/></linearGradient><clipPath id="r"><rect width="114" height="20" rx="3" fill="#fff"/></clipPath><g clip-path="url(#r)"><rect width="61" height="20" fill="#555"/><rect x="61" width="53" height="20" fill="#4c1"/><rect width="114" height="20" fill="url(#s)"/></g><g fill="#fff" text-anchor="middle" font-family="Verdana,Geneva,DejaVu Sans,sans-serif" text-rendering="geometricPrecision" font-size="110"><text aria-hidden="true" x="315" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="510">coverage</text><text x="315" y="140" transform="scale(.1)" fill="#fff" textLength="510">coverage</text><text aria-hidden="true" x="865" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="430">96.64%</text><text x="865" y="140" transform="scale(.1)" fill="#fff" textLength="430">96.64%</text></g></svg>

{exeplot-0.5.2 → exeplot-0.5.5}/docs/mkdocs.yml

@@ -1,10 +1,19 @@
 site_author: dhondta
-site_name: "MalSearch - A library for getting samples from multiple malware databases"
-repo_url: https://github.com/packing-box/python-malsearch
+site_name: ExePlot
+site_description: Library for plotting executable samples supporting multiple formats
+site_url: https://python-exeplot.readthedocs.io
+repo_url: https://github.com/packing-box/python-exeplot
+edit_uri: edit/main/docs/pages/
 copyright: Copyright © 2024 Alexandre D'Hondt
 docs_dir: pages
 nav:
-  - Introduction: index.md
+  - Home: index.md
+  - Installation: installation.md
+  - Command-line tool:
+      - exeplot: cli/exeplot.md
+  - Python API: api.md
+  - How it works: internals.md
+  - Contributing: contributing.md
 extra:
   generator: false
   social:
@@ -20,23 +29,33 @@ extra:
     - icon: fontawesome/brands/twitter
       link: https://twitter.com/alex_dhondt
       name: Alex on Twitter
-extra_css:
-  - css/extra.css
 theme:
   name: material
+  logo: img/logo.png
+  favicon: img/icon.png
   palette:
     - scheme: default
       toggle:
-        icon: material/brightness-7 
+        icon: material/brightness-7
         name: Switch to dark mode
     - scheme: slate
       toggle:
         icon: material/brightness-4
         name: Switch to light mode
-  logo: img/logo.png
-  favicon: img/icon.png
+  features:
+    - content.code.copy
+    - navigation.sections
+    - navigation.top
+    - toc.follow
 use_directory_urls: false
 markdown_extensions:
+  - admonition
+  - attr_list
+  - def_list
+  - pymdownx.details
+  - pymdownx.highlight
+  - pymdownx.inlinehilite
+  - pymdownx.superfences
+  - tables
   - toc:
       permalink: true
-  - admonition

exeplot-0.5.5/docs/pages/api.md

@@ -0,0 +1,190 @@
+# Python API
+
+The `exeplot` package exposes one function per plot type:
+
+```python
+from exeplot import byte, diff, entropy, graph, nested_pie, pie
+```
+
+`exeplot.__all__` lists the plot types that are available. `graph` is only
+there when its [extra](installation.md#the-graph-extra) is installed.
+
+Every function draws the plot, saves it and returns the **list of saved
+image paths**:
+
+```python
+>>> from exeplot import pie
+>>> pie("calc_packed.exe", donut=True, img_format="svg")
+['calc_packed_pie.svg']
+```
+
+---
+
+## Common keyword arguments
+
+All plot functions accept these keyword arguments, on top of their own:
+
+| Argument | Default | Description |
+|---|---|---|
+| `no_title` | `False` | Do not display the title. |
+| `no_legend` | `False` | Do not display the legend. |
+| `img_name` | `<name>_<plot>` | Path of the image, with or without its extension. Missing folders are created. |
+| `img_format` | `png` | Image format and file extension. |
+| `dpi` | `300` | Resolution of the image. |
+| `transparent` | `False` | Save with a transparent background. |
+| `bbox_inches` | `"tight"` | Bounding box of the saved figure. |
+| `grayscale` | `False` | Use the `gray` colormap instead of `colormap_main`. |
+| `interactive_mode` | `False` | Open a Python console before saving (see [Interactive mode](cli/exeplot.md#common-options)). |
+
+The defaults come from the [configuration file](cli/exeplot.md#configuration-file)
+when it sets them.
+
+### Fonts
+
+`font_family` and `font_size` set the base font. Each text element can then
+be changed with `<element>_font_family`, `<element>_font_size` and
+`<element>_font_weight`, where `<element>` is one of:
+
+| Element | Default size | Default weight | Used for |
+|---|---|---|---|
+| `title` | 1.6 × `font_size` | `bold` | The title. |
+| `suptitle` | 1.2 × `font_size` | `normal` | The subtitle. |
+| `annotation` | 0.5 × `font_size` | `normal` | The hash under the title. |
+| `xlabel`, `ylabel` | `font_size` | `normal` | Axis labels and pie percentages. |
+
+```python
+entropy("a.exe", title_font_size=20, title_font_weight="normal")
+```
+
+---
+
+## `byte`
+
+```python
+byte(executable, height=600, grayscale=False, **kwargs)
+```
+
+| Parameter | Description |
+|---|---|
+| `executable` | Path to the executable. |
+| `height` | Height of the image, in pixels. |
+| `grayscale` | One byte per gray pixel, instead of three bytes per RGB pixel. |
+
+---
+
+## `entropy`
+
+```python
+entropy(*filenames, labels=None, sublabel=None, scale=False, target=None, **kwargs)
+```
+
+| Parameter | Description |
+|---|---|
+| `*filenames` | Paths to one or more executables. At least one is required (`ValueError` otherwise). |
+| `labels` | One label per file. Each item is a string, or a function that takes the [data dictionary](#entropy-data) of the file and returns a string. |
+| `sublabel` | Text under each label: a key of `exeplot.plots.__common__.SUBLABELS` (`"ep"`, `"size"`, `"size-ep"`, `"size-ent"`, `"size-ep-ent"`), or a function of the data dictionary. `None` (the default here, unlike the CLI) shows no sublabel. Sublabels that mention the entry point are skipped for files without one. |
+| `scale` | Draw every file on the scale of the first one. |
+| `target` | Name shown in the title, instead of the first file name. |
+| `n_samples` | Number of entropy samples per file (default `2048`). |
+| `legend_location` | Matplotlib location of the legend (default `"lower center"`). A location ending with `left` or `right` puts the legend on one column, beside the plot. |
+| `no_entrypoint` | Do not display the entry point. |
+| `no_label` | Do not display the labels, sublabels and section names. |
+
+```python
+entropy("calc_orig.exe", "calc_packed.exe", scale=True,
+        labels=["Original", lambda d: f"Packed ({d['type']})"], sublabel="size-ent")
+```
+
+### Entropy data
+
+`labels` and `sublabel` functions receive the dictionary returned by
+`exeplot.plots.entropy.data(executable)`:
+
+| Key | Description |
+|---|---|
+| `name`, `hash`, `size`, `type` | File name, SHA-256, size in bytes and format (`PE`, `ELF` or `MachO`). |
+| `entropy` | The entropy samples, divided by 8 (so from 0 to 1). |
+| `entropy*` | The entropy of the whole file, in bits per byte. |
+| `ep` | `(position on the plot, file offset, section name)` of the entry point, or `None`. |
+| `sections` | `(start, end, name, average entropy)` tuples, in samples. |
+
+---
+
+## `pie`
+
+```python
+pie(executable, donut=False, **kwargs)
+```
+
+| Parameter | Description |
+|---|---|
+| `executable` | Path to the executable. |
+| `donut` | Draw a donut instead of a pie. |
+| `no_label` | Do not display the percentages. |
+
+---
+
+## `nested_pie`
+
+```python
+nested_pie(executable, **kwargs)
+```
+
+| Parameter | Description |
+|---|---|
+| `executable` | Path to the executable. |
+
+---
+
+## `diff`
+
+```python
+diff(executable, executable2, legend1="", legend2="", **kwargs)
+```
+
+| Parameter | Description |
+|---|---|
+| `executable` | Path to the reference executable. |
+| `executable2` | Path to the modified executable. Both must have the same format (`ValueError` otherwise). |
+| `legend1`, `legend2` | Labels of the two bars. The file names are used when empty. |
+| `no_colormap` | Do not display the color bar. `no_colorbar` is accepted too. |
+
+---
+
+## `graph`
+
+```python
+graph(executable, algorithm="fast", engine="default", **kwargs)
+```
+
+| Parameter | Description |
+|---|---|
+| `executable` | Path to the executable. |
+| `algorithm` | `"fast"` (`CFGFast`) or `"emulated"` (`CFGEmulated`). |
+| `engine` | `"default"`, `"pcode"` or `"vex"`. |
+
+---
+
+## Utilities: `exeplot.utils`
+
+```python
+from exeplot.utils import ensure_str, human_readable_size, ngrams_counts, ngrams_distribution, shannon_entropy
+```
+
+| Function | Description |
+|---|---|
+| `shannon_entropy(data)` | Shannon entropy of a byte string, in bits per byte (0 to 8). |
+| `human_readable_size(size, precision=0)` | Formats a size in bytes, for example `human_readable_size(1536, 1)` gives `"1.5KB"`. |
+| `ensure_str(s, encoding="utf-8", errors="strict")` | Decodes `bytes`, falling back to Latin-1. Raises `TypeError` for other types. |
+| `ngrams_counts(byte_obj, n=1, step=1)` | Sorted list of `(n-gram, count)` pairs, for `n` from 1 to 3. `byte_obj` is a byte string, or an object with a `bytes` attribute, whose result is then cached on the object. |
+| `ngrams_distribution(byte_obj, n=1, step=1, n_most_common=None, n_exclude_top=0, exclude=None)` | Like `ngrams_counts`, keeping the `n_most_common` n-grams after leaving out the `n_exclude_top` most common ones and the n-grams in `exclude`. |
+
+---
+
+## Constants
+
+| Name | Description |
+|---|---|
+| `exeplot.__version__` | Package version, read from `VERSION.txt`. |
+| `exeplot.config` | The plot style options (see the [configuration file](cli/exeplot.md#configuration-file)). It is updated from `~/.exeplot.conf` before each plot. |
+| `exeplot.logger` | The `exeplot` logger. |