build_package_example_result

scikitplot.cython.build_package_example_result(name, *, cache_dir=None, use_cache=True, force_rebuild=False, verbose=0, profile=None, numpy_support=True, numpy_required=False, include_dirs=None, extra_compile_args=None, extra_link_args=None, compiler_directives=None, include_cwd=True, lock_timeout_s=60.0, language=None)

Build and import a multi-module package example and return a structured result.

Parameters:

namestr

Package example name under _templates/package_examples.

cache_dir, use_cache, force_rebuild, verbose, profile, numpy_support, numpy_required, include_dirs, extra_compile_args, extra_link_args, compiler_directives, include_cwd, lock_timeout_s, language

See scikitplot.cython.build_package_from_paths_result.

Returns:

scikitplot.cython.PackageBuildResult

Structured package build result.

Raises:

ValueError

If metadata is missing required fields.

Parameters:

• name (str)

• cache_dir (str | Path | None)

• use_cache (bool)

• force_rebuild (bool)

• verbose (int)

• profile (str | None)

• numpy_support (bool)

• numpy_required (bool)

• include_dirs (list[str | Path] | None)

• extra_compile_args (list[str] | None)

• extra_link_args (list[str] | None)

• compiler_directives (Mapping[str, Any] | None)

• include_cwd (bool)

• lock_timeout_s (float)

• language (str | None)

Gallery examples

Multi-module package builds (5 package examples)

Multi-module package builds (5 package examples)