summaryrefslogtreecommitdiff
path: root/wrappers/python/README.md
diff options
context:
space:
mode:
authorStevenWdV <stevenwdv@gmail.com>2022-01-24 14:59:25 +0100
committerStevenWdV <stevenwdv@gmail.com>2022-01-24 16:24:57 +0100
commite544c6fa9e15e7277da79e2464243e90b2706b8c (patch)
treede6613747e0e34a799089d4677f9833a85748712 /wrappers/python/README.md
parentaab2e4b966c82b67eb0e204060e5ea6cd4ea15cf (diff)
Cleanup
Added variables to Makefiles to specify custom exports/ directory; Split exception classes in Java & C#; Added more comments; Renamed library and Go package; Removed real (pure) tests; Added generate_lib.ps1 to generate import .lib for Windows (Swift); Moved built Go libraries to exports/lib/; Switch to hopefully faster Swift GitHub Action.
Diffstat (limited to 'wrappers/python/README.md')
-rw-r--r--wrappers/python/README.md15
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