diff options
| author | jwijenbergh <jeroenwijenbergh@protonmail.com> | 2022-05-05 17:47:36 +0200 |
|---|---|---|
| committer | jwijenbergh <jeroenwijenbergh@protonmail.com> | 2022-05-05 17:47:36 +0200 |
| commit | 7bb7885f6eb19547b906513d2664e3730ef5b593 (patch) | |
| tree | ce387ad24da5e3ba3b4d1604d07a5b11d9e68a2e /docs/src/api/python/README.md | |
| parent | 657776055cd07c1f9279e982fbfef88dca1ca71b (diff) | |
Docs: Add API and building improvements
Diffstat (limited to 'docs/src/api/python/README.md')
| -rw-r--r-- | docs/src/api/python/README.md | 11 |
1 files changed, 10 insertions, 1 deletions
diff --git a/docs/src/api/python/README.md b/docs/src/api/python/README.md index 452b575..01a14a0 100644 --- a/docs/src/api/python/README.md +++ b/docs/src/api/python/README.md @@ -1 +1,10 @@ -# Go +# Python +As the Go library is build as a *shared* library, it can be loaded by other languages. We have created wrapper code for Python to use this library. We define the functions and then give a similar example to the Go example. + +The functions that we will discuss are all part of the `EduVPN` class defined in eduvpncommon.main. You can import it like so: + +```python +import eduvpncommon.main as eduvpn + +# Then use eduvpn.EduVPN +``` |
