aboutsummaryrefslogtreecommitdiffstats
path: root/host/lib/deps/pybind11/README.md
blob: 6622895b215903086a86821c54201cb07dadbe9c (plain)
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
# PyBind11: Third-Party Dependency for UHD

Version: 2.6.1 (git hash: f1abf5d)

PyBind11 is a replacement for Boost.Python. Unlike Boost.Python, however, we
ship it with the UHD repository instead of relying on it to be there external to
the repository. The main reason for this is that PyBind11 is not packaged with
most distributions at this time. It also allows us to lock down the version of
PyBind11 used; with Boost, we often have to apply hacks to make sure UHD works
across all of the Boost versions that we support.

Note that the UHD CMake allows for using a different version of PyBind11 (e.g.,
the one installed via package manager).

## License for PyBind11

As a seperate, third-party project, PyBind11 has a different license from UHD.
See the LICENSE file in the same directory as this readme. PyBind11 has a
3-clause BSD-style license.

## Importing into UHD

In order to copy PyBind11 into UHD, only the `include/` subdirectory from the
PyBind11 repository was copied into UHD.
To save space, all comments were stripped from PyBind11 source files, except for
the copyright header, using the `remove_comments.py` script.