summaryrefslogtreecommitdiff
path: root/wrappers/python/README.md
diff options
context:
space:
mode:
authorjwijenbergh <jeroenwijenbergh@protonmail.com>2024-03-22 11:52:28 +0100
committerJeroen Wijenbergh <46386452+jwijenbergh@users.noreply.github.com>2024-03-22 13:30:41 +0100
commit9bab3c87825b4284b3e6f2be3fa9e89da7723116 (patch)
tree6049f03402f23168c5000e9843a979935cd0996d /wrappers/python/README.md
parentf94e6471268c12b7b5c7fd1c8b8800dac3848d6c (diff)
All: Refactor makefile & building
Diffstat (limited to 'wrappers/python/README.md')
-rw-r--r--wrappers/python/README.md27
1 files changed, 5 insertions, 22 deletions
diff --git a/wrappers/python/README.md b/wrappers/python/README.md
index 6f0bec1..905d7d4 100644
--- a/wrappers/python/README.md
+++ b/wrappers/python/README.md
@@ -2,42 +2,25 @@
## Requirements
-Python 3.6+ is assumed, but it may work with older versions. To build, `setuptools` and `wheel` are required.
+Python 3.6+ is assumed, but it may work with older versions. To build, `setuptools`, `wheel` and `build` are required.
-## Build & test
+## Building
-First build the shared Go library. Next:
+First build the shared Go library by following the instructions in the root directory of this Repo.
-Build wheel using library for current platform:
+Then, to build the wheel use:
```shell
make pack
```
-(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
-```
-
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.
-
-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 `common.mk` and the `lib/` folder with built libraries.
-
-Test:
-
+## Running tests
```shell
make test
```