https://github.com/pybind/python_example
Example pybind11 module built with a Python-based build system
https://github.com/pybind/python_example
Last synced: 11 days ago
JSON representation
Example pybind11 module built with a Python-based build system
- Host: GitHub
- URL: https://github.com/pybind/python_example
- Owner: pybind
- License: other
- Created: 2016-01-29T08:23:27.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2026-03-30T21:32:05.000Z (17 days ago)
- Last Synced: 2026-04-05T17:44:25.870Z (11 days ago)
- Language: Python
- Homepage:
- Size: 151 KB
- Stars: 529
- Watchers: 12
- Forks: 154
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-list - python_example - Example pybind11 module built with a Python-based build system. (Programming Language Tutorials / Python)
README
python_example
==============
[![Gitter][gitter-badge]][gitter-link]
| CI | status |
|----------------------|--------|
| pip builds | [![Pip Actions Status][actions-pip-badge]][actions-pip-link] |
| [`cibuildwheel`][] | [![Wheels Actions Status][actions-wheels-badge]][actions-wheels-link] |
[gitter-badge]: https://badges.gitter.im/pybind/Lobby.svg
[gitter-link]: https://gitter.im/pybind/Lobby
[actions-badge]: https://github.com/pybind/python_example/workflows/Tests/badge.svg
[actions-pip-link]: https://github.com/pybind/python_example/actions?query=workflow%3A%22Pip
[actions-pip-badge]: https://github.com/pybind/python_example/workflows/Pip/badge.svg
[actions-wheels-link]: https://github.com/pybind/python_example/actions?query=workflow%3AWheels
[actions-wheels-badge]: https://github.com/pybind/python_example/workflows/Wheels/badge.svg
An example project built with [pybind11](https://github.com/pybind/pybind11).
This requires Python 3.7+; for older versions of Python, check the commit
history.
Installation
------------
- clone this repository
- `pip install ./python_example`
CI Examples
-----------
There are examples for CI in `.github/workflows`. A simple way to produces
binary "wheels" for all platforms is illustrated in the "wheels.yml" file,
using [`cibuildwheel`][]. You can also see a basic recipe for building and
testing in `pip.yml`, and `conda.yml` has an example of a conda recipe build.
Building the documentation
--------------------------
Documentation for the example project is generated using Sphinx. Sphinx has the
ability to automatically inspect the signatures and documentation strings in
the extension module to generate beautiful documentation in a variety formats.
The following command generates HTML-based reference documentation; for other
formats please refer to the Sphinx manual:
- `cd python_example/docs`
- `make html`
License
-------
pybind11 is provided under a BSD-style license that can be found in the LICENSE
file. By using, distributing, or contributing to this project, you agree to the
terms and conditions of this license.
Test call
---------
```python
import python_example
python_example.add(1, 2)
```
[`cibuildwheel`]: https://cibuildwheel.readthedocs.io