Skip to content

Commit bc2cb76

Browse files
committed
[ci skip] note about version
1 parent c713af7 commit bc2cb76

1 file changed

Lines changed: 14 additions & 0 deletions

File tree

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,20 @@ python -m pip install ./
2525
* A tutorial on how to use the bindings can be found [here](https://libigl.github.io/libigl-python-bindings/tutorials/)
2626
* A function reference can be found [here](https://libigl.github.io/libigl-python-bindings/igl_docs/)
2727

28+
## Getting the current version of libigl within python code
29+
30+
Since version 2.5.4.dev0, the `igl.__version__` attribute has been removed. To
31+
get the version of the libigl package you're using within your python code, you
32+
can use the following code:
33+
34+
```
35+
import importlib.metadata
36+
libigl_version = importlib.metadata.version('libigl')
37+
```
38+
39+
The version of libigl is defined in the [pyproject.toml](./pyproject.toml) file.
40+
41+
2842
## Compiling and modifying the bindiings
2943

3044
According to the [scikit-build-core documentation](https://scikit-build-core.readthedocs.io/en/latest/configuration.html#editable-installs), the way to make an editable (incremental) build is to:

0 commit comments

Comments
 (0)