diff options
Diffstat (limited to 'wrappers/python/README.md')
| -rw-r--r-- | wrappers/python/README.md | 15 |
1 files changed, 10 insertions, 5 deletions
diff --git a/wrappers/python/README.md b/wrappers/python/README.md index 6175910..bce492e 100644 --- a/wrappers/python/README.md +++ b/wrappers/python/README.md @@ -2,9 +2,7 @@ ## Requirements -Python 3.6+ is assumed, but it may work with older versions. - -TODO Build +Python 3.6+ is assumed, but it may work with older versions. To build, `setuptools` and `wheel` are required. ## Build & test @@ -16,7 +14,11 @@ Build wheel using library for current platform: make pack ``` -Build wheel using library for specified platform (passed to setuptools `--plat-name`): +(This does not build the shared Go library.) + +Build wheel using library for specified platform (passed to setuptools `--plat-name`, +see [`get_build_platform`](https://setuptools.pypa.io/en/latest/pkg_resources.html?highlight=get_build_platform#platform-utilities) +for more): ```shell make pack PLAT_NAME=win32 @@ -28,9 +30,12 @@ To install the wheel, run: 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` +You could also reference the discovery module directly and copy the library for the platform to the `eduvpncommon/lib/` folder. +If you do not build this as part of the full repository, specify `EXPORTS_PATH="path/to/exports-folder"` when calling +make. This folder must contain `platform.mk` and the `lib/` folder with built libraries. + Test: ```shell |