summaryrefslogtreecommitdiff
path: root/wrappers/python/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'wrappers/python/README.md')
-rw-r--r--wrappers/python/README.md25
1 files changed, 23 insertions, 2 deletions
diff --git a/wrappers/python/README.md b/wrappers/python/README.md
index fddcde6..b849e62 100644
--- a/wrappers/python/README.md
+++ b/wrappers/python/README.md
@@ -4,11 +4,32 @@
Python 3.6+ is assumed, but it may work with older versions.
-## Test
+TODO Build
+
+## Build & test
First build the shared Go library. Next:
-No dependencies, just reference `discovery.py` and call `verify`.
+Build wheel using library for current platform:
+
+```shell
+make
+```
+
+Build wheel using library for specified platform (passed to setuptools `--plat-name`):
+
+```shell
+make PLAT_NAME=win32
+```
+
+To install the wheel, run:
+
+```shell
+pip install dist/eduvpncommon-[version]-py3-none-[platform].whl
+```
+
+You could also reference the discovery module directly and copy the library for the platform to the `eduvpncommon/lib`
+folder.
Test: