1
1
# scikit-build-core
2
2
3
3
[ ![ Actions Status] [ actions-badge ]] [ actions-link ]
4
- [ ![ Documentation Status] [ rtd-badge ]] [ rtd-link ]
5
4
[ ![ Code style: black] [ black-badge ]] [ black-link ]
6
5
[ ![ codecov] [ codecov-badge ]] [ codecov-link ]
6
+ [ ![ GitHub Discussion] [ github-discussions-badge ]] [ github-discussions-link ]
7
7
8
- <!-- Not implemented yet
9
8
[ ![ PyPI version] [ pypi-version ]] [ pypi-link ]
10
- [![Conda-Forge][conda-badge]][conda-link]
11
9
[ ![ PyPI platforms] [ pypi-platforms ]] [ pypi-link ]
12
10
13
- [![GitHub Discussion][github-discussions-badge]][github-discussions-link]
11
+ <!-- Not implemented yet
12
+ [![Documentation Status][rtd-badge]][rtd-link]
13
+ [![Conda-Forge][conda-badge]][conda-link]
14
14
[![Gitter][gitter-badge]][gitter-link]
15
15
-->
16
16
@@ -19,6 +19,21 @@ is experimental and likely to move to a separate package), and internal API is
19
19
still being solidified. A future version of this package will support creating
20
20
new build extensions.
21
21
22
+ Features over classic Scikit-build:
23
+
24
+ - Better warnings, errors, and logging
25
+ - No warning about unused variables
26
+ - Automatically adds Ninja and/or CMake only as required
27
+ - No dependency on setuptools, distutils, or wheel in build mode.
28
+ - Powerful config system, including config options support in build mode.
29
+ - Automatic inclusion of site-packages in ` CMAKE_PREFIX_PATH `
30
+ - FindPython is backported if running on CMake < 3.24 (included via hatchling in
31
+ a submodule, configurable)
32
+ - Limited API / Stable ABI and pythonless tags supported via config option
33
+ - No slow generator search, ninja/make or MSVC used by default, respects
34
+ ` CMAKE_GENERATOR `
35
+ - SDists are reproducible by default (UNIX, Python 3.9+)
36
+
22
37
The following limitations are present compared to classic scikit-build:
23
38
24
39
- The minimum supported CMake is 3.15
@@ -36,26 +51,11 @@ Some known missing features that will be developed soon:
36
51
37
52
Other backends are also planned:
38
53
39
- - Setuptools integration highly experimental currently
54
+ - Setuptools integration highly experimental
40
55
- The extensionlib integration is missing
41
56
- No hatchling plugin yet
42
57
43
- Features over classic Scikit-build:
44
-
45
- - Better warnings, errors, and logging
46
- - No warning about unused variables
47
- - Automatically adds Ninja and/or CMake only as required
48
- - No dependency on setuptools, distutils, or wheel in build mode.
49
- - Powerful config system, including config options support in build mode.
50
- - Automatic inclusion of site-packages in ` CMAKE_PREFIX_PATH `
51
- - FindPython is backported if running on CMake < 3.24 (included via hatchling in
52
- a submodule, configurable)
53
- - Limited API / Stable ABI and pythonless tags supported via config option
54
- - No slow generator search, ninja/make or MSVC used by default, respects
55
- ` CMAKE_GENERATOR `
56
- - SDists are reproducible by default (UNIX, Python 3.9+)
57
-
58
- Currently, the recommended interface is the PEP 517 interface. There is also a
58
+ The recommended interface is the PEP 517 interface. There is also a
59
59
setuptools-based interface that is being developed to provide a transition path
60
60
for classic scikit-build.
61
61
@@ -199,7 +199,7 @@ Support for this work was provided by NSF cooperative agreement [OAC-2209877][].
199
199
[ conda-badge ] : https://img.shields.io/conda/vn/conda-forge/scikit-build-core
200
200
[ conda-link ] : https://github.com/conda-forge/scikit-build-core-feedstock
201
201
[ github-discussions-badge ] : https://img.shields.io/static/v1?label=Discussions&message=Ask&color=blue&logo=github
202
- [ github-discussions-link ] : https://github.com/scikit-build /scikit-build-core /discussions
202
+ [ github-discussions-link ] : https://github.com/orgs /scikit-build/discussions
203
203
[ gitter-badge ] : https://badges.gitter.im/https://github.com/scikit-build/scikit-build-core/community.svg
204
204
[ gitter-link ] : https://gitter.im/https://github.com/scikit-build/scikit-build-core/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge
205
205
[ codecov-badge ] : https://codecov.io/gh/scikit-build/scikit-build-core/branch/main/graph/badge.svg?token=ZLbQzIvyG8
@@ -209,6 +209,5 @@ Support for this work was provided by NSF cooperative agreement [OAC-2209877][].
209
209
[ pypi-version ] : https://badge.fury.io/py/scikit-build-core.svg
210
210
[ rtd-badge ] : https://readthedocs.org/projects/scikit-build-core/badge/?version=latest
211
211
[ rtd-link ] : https://scikit-build-core.readthedocs.io/en/latest/?badge=latest
212
- [ sk-badge ] : https://scikit-hep.org/assets/images/Scikit--HEP-Project-blue.svg
213
212
[ OAC-2209877 ] : https://www.nsf.gov/awardsearch/showAward?AWD_ID=2209877&HistoricalAwards=false
214
213
<!-- prettier-ignore-end -->
0 commit comments