skbuild.command package¶
Collection of objects allowing to customize behavior of standard distutils and setuptools commands.
-
class
skbuild.command.
set_build_base_mixin
[source]¶ Bases:
object
Mixin allowing to override distutils and setuptools commands.
Submodules¶
skbuild.command.bdist module¶
This module defines custom implementation of bdist
setuptools command.
-
class
skbuild.command.bdist.
bdist
(dist, **kw)[source]¶ Bases:
skbuild.command.set_build_base_mixin
,skbuild.utils.NewStyleClass
Custom implementation of
bdist
setuptools command.
skbuild.command.bdist_wheel module¶
This module defines custom implementation of bdist_wheel
setuptools
command.
-
class
skbuild.command.bdist_wheel.
bdist_wheel
(dist, **kw)[source]¶ Bases:
skbuild.command.set_build_base_mixin
,skbuild.utils.NewStyleClass
Custom implementation of
bdist_wheel
setuptools command.
skbuild.command.build module¶
This module defines custom implementation of build
setuptools command.
-
class
skbuild.command.build.
build
(dist, **kw)[source]¶ Bases:
skbuild.command.set_build_base_mixin
,skbuild.utils.NewStyleClass
Custom implementation of
build
setuptools command.
skbuild.command.build_py module¶
This module defines custom implementation of build_py
setuptools
command.
-
class
skbuild.command.build_py.
build_py
(dist, **kw)[source]¶ Bases:
skbuild.command.set_build_base_mixin
,skbuild.utils.NewStyleClass
Custom implementation of
build_py
setuptools command.-
build_module
(module, module_file, package)[source]¶ Handle –hide-listing option.
Increments
outfiles_count
.
-
find_modules
()[source]¶ Finds individually-specified Python modules, ie. those listed by module name in ‘self.py_modules’. Returns a list of tuples (package, module_base, filename): ‘package’ is a tuple of the path through package-space to the module; ‘module_base’ is the bare (no packages, no dots) module name, and ‘filename’ is the path to the “.py” file (relative to the distribution root) that implements the module.
-
skbuild.command.clean module¶
This module defines custom implementation of clean
setuptools command.
-
class
skbuild.command.clean.
clean
(dist, **kw)[source]¶ Bases:
skbuild.command.set_build_base_mixin
,skbuild.utils.NewStyleClass
Custom implementation of
clean
setuptools command.
skbuild.command.egg_info module¶
This module defines custom implementation of egg_info
setuptools
command.
-
class
skbuild.command.egg_info.
egg_info
(dist, **kw)[source]¶ Bases:
skbuild.command.set_build_base_mixin
,skbuild.utils.NewStyleClass
Custom implementation of
egg_info
setuptools command.
skbuild.command.generate_source_manifest module¶
This module defines custom generate_source_manifest
setuptools
command.
-
class
skbuild.command.generate_source_manifest.
generate_source_manifest
(dist)[source]¶ Bases:
skbuild.command.set_build_base_mixin
,skbuild.utils.NewStyleClass
Custom setuptools command generating a MANIFEST file if not already provided.
-
description
= 'generate source MANIFEST'¶
-
finalize_options
(*args, **kwargs)[source]¶ Set final values for all the options that this command supports.
-
run
()[source]¶ If neither a MANIFEST, nor a MANIFEST.in file is provided, and we are in a git repo, try to create a MANIFEST file from the output of git ls-tree –name-only -r HEAD.
We need a reliable way to tell if an existing MANIFEST file is one we’ve generated. distutils already uses a first-line comment to tell if the MANIFEST file was generated from MANIFEST.in, so we use a dummy file, _skbuild_MANIFEST, to avoid confusing distutils.
-
skbuild.command.install module¶
This module defines custom implementation of install
setuptools
command.
-
class
skbuild.command.install.
install
(dist, **kw)[source]¶ Bases:
skbuild.command.set_build_base_mixin
,skbuild.utils.NewStyleClass
Custom implementation of
install
setuptools command.
skbuild.command.install_lib module¶
This module defines custom implementation of install_lib
setuptools
command.
-
class
skbuild.command.install_lib.
install_lib
(dist, **kw)[source]¶ Bases:
skbuild.command.set_build_base_mixin
,skbuild.utils.NewStyleClass
Custom implementation of
install_lib
setuptools command.
skbuild.command.install_scripts module¶
This module defines custom implementation of install_scripts
setuptools
command.
-
class
skbuild.command.install_scripts.
install_scripts
(dist, **kw)[source]¶ Bases:
skbuild.command.set_build_base_mixin
,skbuild.utils.NewStyleClass
Custom implementation of
install_scripts
setuptools command.
skbuild.command.sdist module¶
This module defines custom implementation of sdist
setuptools command.
-
class
skbuild.command.sdist.
sdist
(dist, **kw)[source]¶ Bases:
skbuild.command.set_build_base_mixin
,skbuild.utils.NewStyleClass
Custom implementation of
sdist
setuptools command.-
make_archive
(base_name, _format, root_dir=None, base_dir=None, owner=None, group=None)[source]¶ Handle –hide-listing option.
-
make_distribution
()[source]¶ This function was originally re-implemented in setuptools to workaround https://github.com/pypa/setuptools/issues/516 and later ported to scikit-build to ensure symlinks are maintained.
-
run
(*args, **kwargs)[source]¶ Force
egg_info.egg_info
command to run.
-