From 7bb7885f6eb19547b906513d2664e3730ef5b593 Mon Sep 17 00:00:00 2001 From: jwijenbergh Date: Thu, 5 May 2022 17:47:36 +0200 Subject: Docs: Add API and building improvements --- docs/src/gettingstarted/building/python.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 docs/src/gettingstarted/building/python.md (limited to 'docs/src/gettingstarted/building/python.md') 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 +``` -- cgit v1.2.3