Metadata-Version: 2.4
Name: binwalk-python-sdk
Version: 0.0.1
Summary: Python bindings for running binwalk
License: MIT
License-File: LICENSE
Author: pUrGe12
Author-email: achintya.jai@owasp.org
Requires-Python: >=3.10
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Requires-Dist: maturin (>=1.10.2,<2.0.0)
Requires-Dist: patchelf (>=0.17.2.4,<0.18.0.0)
Description-Content-Type: text/markdown

# Binwalk-python

This is a python SDK for using Binwalk (which is now a Rust project). You can install this library from PyPI.

>[!NOTE]
>This library is not exposing every possible feature of binwalk yet. In due time, it might

## Installation

#### Install via pip

```sh
pip install binwalk-python
```

#### or build it from this repo

```sh
git clone https://github.com/FauvidoTechnologies/binwalk-python-sdk
cd binwalk-python-sdk
pip install -e .
```

## Usage

We're currently exposing just one endpoint, which is `basic_scan`. This is equivalent to doing `binwalk.scan(&data)` in the rust counterpart (or `binwalk filename`).

```py
from pybinwalk import basic_scan

result = basic_scan(image_path)
print(type(result))
# List

```
