check_build_prereqs#

scikitplot.cython.check_build_prereqs(*, numpy=False, pybind11=False)[source]#

Check whether build prerequisites are importable.

Parameters:

numpybool, default=False: If True, also check NumPy availability.
pybind11bool, default=False: If True, also check pybind11 availability (Scenario 3 & 4).

Returns:

dict[str, Any]: Keys: cython, setuptools, optionally numpy, pybind11. Each value: {"ok": bool, "version": str}.

Parameters:

numpy (bool)
pybind11 (bool)

Return type:

dict[str, Any]

Notes

Newbie (Scenarios 1 & 2): run this to understand your environment. Pro/master (Scenarios 3-5): use the scenario-specific helpers in scikitplot.cython._custom_compiler for targeted checks.

Examples

>>> result = check_build_prereqs()
>>> "cython" in result and "setuptools" in result
True
>>> result = check_build_prereqs(numpy=True, pybind11=True)
>>> all(k in result for k in ("cython", "setuptools", "numpy", "pybind11"))
True