Skip to content

Commit bd1b2a3

Browse files
committed
Add a note about the python bindings to the readme.
1 parent db97f9e commit bd1b2a3

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

README.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,13 @@ or by specifying one comparison policy and threshold (100ms for example), and re
7676

7777
More usage please check the unittest.
7878

79+
## Python bindings
80+
81+
The library can be used in Python via pybind11 bindings.
82+
Since util_caching is a template library, we need to explicitly instantiate the template for the types we want to use in Python.
83+
For this, we provide the convenience functions `bindNumberBasedCache` and `bindTimeBasedCache`.
84+
Check the unit test for a usage example.
85+
7986

8087
## Installation
8188

@@ -178,4 +185,4 @@ docker compose -f demo/docker-compose.ros.yaml build
178185
docker compose -f demo/docker-compose.ros.yaml run --rm util_caching_ros
179186
```
180187
181-
See [demo/README.md](demo/README.md) for how to run the demo, showcasing the use of `util_caching` in a ROS node.
188+
See [demo/README.md](demo/README.md) for how to run the demo, showcasing the use of `util_caching` in a ROS node.

0 commit comments

Comments
 (0)