scikit_build_core.setuptools package¶

Submodules¶

scikit_build_core.setuptools.build_cmake module¶

class scikit_build_core.setuptools.build_cmake.BuildCMake(dist, **kw)[source]¶

Bases: Command

build_lib: str | None¶

build_temp: str | None¶

cmake_args: list[str] | str | None = None¶

cmake_install_target: str | None = None¶

debug: bool | None¶

editable_mode: bool¶

finalize_options()[source]¶

Set final values for all options/attributes used by the command. Most of the time, each option/attribute/cache should only be set if it does not have any value yet (e.g. if self.attr is None: self.attr = val).

Return type:: None

initialize_options()[source]¶

Set or (reset) all options/attributes/caches used by the command to their default values. Note that these values may be overwritten during the build.

Return type:: None

parallel: int | None¶

plat_name: str | None¶

run()[source]¶

Execute the actions intended by the command. (Side effects SHOULD only take place when run() is executed, for example, creating new files or writing to the terminal output).

Return type:: None

source_dir: str | None = None¶

user_options: ClassVar[list[tuple[str, str, str]]] = [('build-lib=', 'b', 'directory for compiled extension modules'), ('build-temp=', 't', 'directory for temporary files (build by-products)'), ('plat-name=', 'p', 'platform name to cross-compile for, if supported '), ('debug', 'g', 'compile/link with debugging information'), ('parallel=', 'j', 'number of parallel build jobs'), ('source-dir=', 's', 'directory with CMakeLists.txt'), ('cmake-args=', 'a', 'extra arguments for CMake'), ('cmake-install-target=', '', 'CMake target to install')]¶

scikit_build_core.setuptools.build_cmake.cmake_args(dist, attr, value)[source]¶

Return type:: None

scikit_build_core.setuptools.build_cmake.cmake_install_target(dist, attr, value)[source]¶

Return type:: None

scikit_build_core.setuptools.build_cmake.cmake_source_dir(dist, attr, value)[source]¶

Return type:: None

scikit_build_core.setuptools.build_cmake.finalize_distribution_options(dist)[source]¶

Return type:: None

scikit_build_core.setuptools.build_meta module¶

scikit_build_core.setuptools.build_meta.build_editable(wheel_directory, config_settings=None, metadata_directory=None)¶

Return type:: str

scikit_build_core.setuptools.build_meta.build_sdist(sdist_directory, config_settings=None)¶

Return type:: str

scikit_build_core.setuptools.build_meta.build_wheel(wheel_directory, config_settings=None, metadata_directory=None)¶

Return type:: str

scikit_build_core.setuptools.build_meta.get_requires_for_build_editable(config_settings=None)[source]¶

Return type:: list[str]

scikit_build_core.setuptools.build_meta.get_requires_for_build_sdist(config_settings=None)[source]¶

Return type:: list[str]

scikit_build_core.setuptools.build_meta.get_requires_for_build_wheel(config_settings=None)[source]¶

Return type:: list[str]

scikit_build_core.setuptools.build_meta.prepare_metadata_for_build_editable(metadata_directory, config_settings=None)¶

Return type:: str

scikit_build_core.setuptools.build_meta.prepare_metadata_for_build_wheel(metadata_directory, config_settings=None)¶

Return type:: str

scikit_build_core.setuptools.wrapper module¶

scikit_build_core.setuptools.wrapper.setup(*, cmake_args=(), cmake_install_dir='', cmake_source_dir='', cmake_with_sdist=False, cmake_languages=None, cmake_minimum_required_version=None, cmake_process_manifest_hook=None, cmake_install_target='install', distclass=<class 'setuptools.dist.Distribution'>, **kw)[source]¶

Return type:: TypeVar(_DistributionT, bound= setuptools._distutils.dist.Distribution)