diff options
| author | jwijenbergh <jeroenwijenbergh@protonmail.com> | 2022-05-05 17:47:36 +0200 |
|---|---|---|
| committer | jwijenbergh <jeroenwijenbergh@protonmail.com> | 2022-05-05 17:47:36 +0200 |
| commit | 7bb7885f6eb19547b906513d2664e3730ef5b593 (patch) | |
| tree | ce387ad24da5e3ba3b4d1604d07a5b11d9e68a2e /docs/src/gettingstarted/building/python.md | |
| parent | 657776055cd07c1f9279e982fbfef88dca1ca71b (diff) | |
Docs: Add API and building improvements
Diffstat (limited to 'docs/src/gettingstarted/building/python.md')
| -rw-r--r-- | docs/src/gettingstarted/building/python.md | 19 |
1 files changed, 19 insertions, 0 deletions
diff --git a/docs/src/gettingstarted/building/python.md b/docs/src/gettingstarted/building/python.md new file mode 100644 index 0000000..6995f9e --- /dev/null +++ b/docs/src/gettingstarted/building/python.md @@ -0,0 +1,19 @@ +# Python Wrapper + +To build the python wrapper issue the following command (in the root directory of the eduvpn-common project): + +```bash +make -C wrappers/python +``` + +This uses the makefile in `wrappers/python/Makefile` to build the python file into a wheel placed in `wrappers/python/dist/eduvpncommon-[version]-py3-none-[platform].whl`. Where version is the version of the library and platform is your current platform. Like Go you can also build for a specific platform: + +```bash +make PLAT_NAME=win32 +``` + +The wheel can be installed with `pip`: + +```bash +pip install ./wrappers/python/dist/eduvpncommon-[version]-py3-none-[platform].whl +``` |
