Skip to content

Commit

Permalink
Add a note about the python bindings to the readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
ll-nick committed Oct 18, 2024
1 parent db97f9e commit 826bb80
Showing 1 changed file with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,13 @@ or by specifying one comparison policy and threshold (100ms for example), and re

More usage please check the unittest.

## Pythond bindings

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


## Installation

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

0 comments on commit 826bb80

Please sign in to comment.