1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
|
# nanobind_example
| CI | status |
| ---------- | ------------------------------------------------------------------- |
| pip builds | [![Pip Action Status][actions-pip-badge]][actions-pip-link] |
| wheels | [![Wheel Action Status][actions-wheels-badge]][actions-wheels-link] |
[actions-pip-link]:
https://github.com/wjakob/nanobind_example/actions?query=workflow%3APip
[actions-pip-badge]:
https://github.com/wjakob/nanobind_example/workflows/Pip/badge.svg
[actions-wheels-link]:
https://github.com/wjakob/nanobind_example/actions?query=workflow%3AWheels
[actions-wheels-badge]:
https://github.com/wjakob/nanobind_example/workflows/Wheels/badge.svg
This repository contains a tiny project showing how to create C++ bindings using
[nanobind](https://github.com/wjakob/nanobind) and
[scikit-build-core](https://scikit-build-core.readthedocs.io/en/latest/index.html).
It was derived from the corresponding _pybind11_
[example project](https://github.com/pybind/scikit_build_example/) developed by
[@henryiii](https://github.com/henryiii).
## Installation
1. Clone this repository
2. Run `pip install ./nanobind_example`
Afterwards, you should be able to issue the following commands (shown in an
interactive Python session):
```pycon
>>> import nanobind_example
>>> nanobind_example.add(1, 2)
3
```
## CI Examples
The `.github/workflows` directory contains two continuous integration workflows
for GitHub Actions. The first one (`pip`) runs automatically after each commit
and ensures that packages can be built successfully and that tests pass.
The `wheels` workflow uses [cibuildwheel](https://cibuildwheel.pypa.io) to
automatically produce binary wheels for a large variety of platforms. If a
`pypi_password` token is provided using GitHub Action's _secrets_ feature, this
workflow can even automatically upload packages on PyPI.
## License
_nanobind_ and this example repository are both provided under a BSD-style
license that can be found in the [LICENSE](./LICENSE) file. By using,
distributing, or contributing to this project, you agree to the terms and
conditions of this license.
|
