Skip to content

Commit

Permalink
Make backend loaders as required dependencies
Browse files Browse the repository at this point in the history
  • Loading branch information
patacca committed Oct 12, 2023
1 parent 5cbd91d commit 994a06d
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 30 deletions.
28 changes: 1 addition & 27 deletions doc/source/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -36,34 +36,8 @@ Then it can be built with:
pip install .
Optional Backend Dependencies
-----------------------------

The various program representation backend that can be used are to
be installed separately (in the same virtualenv than QBinDiff).

Available backends are:
This will install also all the following backend loaders:

- `Quokka <https://github.com/quarkslab/quokka>`_, provided by Quarkslab

.. code-block:: bash
pip install qbindiff[quokka]
- `BinExport <https://github.com/google/binexport>`_ , developed by Google. Through the python bindings provided by Quarkslab with `python-binexport <https://github.com/quarkslab/python-binexport>`_

.. code-block:: bash
pip install qbindiff[binexport]
- IDA Pro (to be used directly within IDA) through `idascript <https://github.com/quarkslab/idascript>`_.

.. code-block:: bash
pip install qbindiff[ida]
You can install multiple backend loaders by using a comma to separate them. Ex:

.. code-block:: bash
pip install qbindiff[quokka,binexport,ida]
6 changes: 3 additions & 3 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,9 @@ dependencies = [
"python-louvain",
"enum_tools",
"python-bindiff",
"python-binexport",
"quokka-project",
"idascript",
]
dynamic = ["version"]

Expand All @@ -41,9 +44,6 @@ Repository = "https://github.com/quarkslab/qbindiff"
Documentation = "https://github.com/quarkslab/qbindiff"

[project.optional-dependencies]
binexport = ["python-binexport"]
quokka = ["quokka-project"]
ida = ["idascript"]
doc = [
"sphinx>=7,<7.2.0",
"sphinx-design",
Expand Down

0 comments on commit 994a06d

Please sign in to comment.