summaryrefslogtreecommitdiff
path: root/docs/src
diff options
context:
space:
mode:
authorjwijenbergh <jeroenwijenbergh@protonmail.com>2022-10-24 08:46:14 +0200
committerjwijenbergh <jeroenwijenbergh@protonmail.com>2022-10-24 09:23:18 +0200
commit56f084389a3eb6b34df86af347ce60acdeb6106b (patch)
tree3e3fc02086b7b246752a6dc4804551dd05b4dfa3 /docs/src
parent1f3a6e09d3b605fb70cd0dd2165373814feb2eda (diff)
Actions + Docs: Use Sphinx docs for Python
Diffstat (limited to 'docs/src')
-rw-r--r--docs/src/SUMMARY.md1
-rw-r--r--docs/src/api/python/README.md10
-rw-r--r--docs/src/api/python/functions.md101
3 files changed, 1 insertions, 111 deletions
diff --git a/docs/src/SUMMARY.md b/docs/src/SUMMARY.md
index 9274cee..6ec2259 100644
--- a/docs/src/SUMMARY.md
+++ b/docs/src/SUMMARY.md
@@ -22,5 +22,4 @@
- [Go](./api/go/README.md)
- [Example](./api/go/example.md)
- [Python](./api/python/README.md)
- - [Functions](./api/python/functions.md)
- [Example](./api/python/example.md)
diff --git a/docs/src/api/python/README.md b/docs/src/api/python/README.md
index e15511f..6bc66b6 100644
--- a/docs/src/api/python/README.md
+++ b/docs/src/api/python/README.md
@@ -1,10 +1,2 @@
# 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 `eduvpn_common.main`. You can import it like so:
-
-```python
-import eduvpn_common.main as eduvpn
-
-# Then use eduvpn.EduVPN
-```
+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. The api documentation can be found [here](./rtd/index.html). In the next chapter we will give a similar example to the Go example.
diff --git a/docs/src/api/python/functions.md b/docs/src/api/python/functions.md
deleted file mode 100644
index 2b909a8..0000000
--- a/docs/src/api/python/functions.md
+++ /dev/null
@@ -1,101 +0,0 @@
-# Functions
-## Creating the class
-See [Overview](../overview/registering.html)
-
-This creates the class and basically forwards these arguments when `register` is called.
-```python
-def __init__(self, name: str, directory: str)
-```
-- `name`: The name of the client
-- `directory`: The directory where the configs and logging should be stored
-
-## Registering
-See [Overview](../overview/registering.html)
-```python
-def register(self, debug: bool = False) -> None
-```
-- `debug`: Whether or not we want to enable debugging, default: `False`
-
-Returns nothing. Raises an exception in case of an error.
-
-## Discovery
-See [Overview](../overview/discovery.html)
-```python
-def get_disco_servers(self) -> str
-```
-```python
-def get_disco_organizations(self) -> str
-```
-
-Returns a `string` of JSON data with the servers/organizations. Raises an exception in case of an error.
-
-## OpenVPN/Wireguard config
-See [Overview](../overview/getconfig.html)
-```python
-def get_config_institute_access(self, url: str, preferTCP: bool = False) -> Tuple[str, str]
-```
-```python
-def get_config_secure_internet(self, url: str, preferTCP: bool = False) -> Tuple[str, str]
-```
-- `url`: The url of the Secure Internet or Institute Access server to get a connect config for
-- `preferTCP`: Whether or not we want to prefer TCP, default: `False`
-
-Returns:
-- A `string` of the OpenVPN/Wireguard config
-- An `string`, `openvpn` or `wireguard` indicating if it is an OpenVPN or Wireguard config
-
-Raises an exception in case of an error.
-
-### Cancelling OAuth
-```python
-def cancel_oauth(self) -> None
-```
-
-Returns nothing. Raises an exception in case of an error.
-
-### Setting a profile ID
-```python
-def set_profile(self, profile_id: str) -> None
-```
-- `profile_id`: The profile ID to connect to
-
-Returns nothing. Raises an exception in case of an errorr.
-
-## Connecting/Disconnecting
-See [Overview](../overview/connecting.html)
-```python
-def set_connected(self) -> None
-```
-```python
-def set_disconnected(self) -> None
-```
-
-Returns an nothing. Raises an exception in case of an error.
-
-## Deregister
-See [Overview](../overview/deregistering.html)
-```python
-def deregister() -> None
-```
-
-Returns nothing. Raises an exception in case of an error.
-
-# Note on Callbacks
-Some functions (e.g. [the API for getting an OpenVPN/Wireguard config](http://localhost:3000/api/overview/getconfig.html)) need a (or multiple) callbacks set. In Python, the callback function is set using decorators.
-For this, the `eduvpn.EduVPN` class has the following syntax:
-
-```python
-# Where _eduvpn is the eduvpn.EduVPN class instance
-# This gets called when the New_State_Example state is entered
-# old_state is then the old state
-@_eduvpn.event.on("New_State_Example", eduvpn.StateType.ENTER)
-def example_enter(old_state: str, data: str)
-```
-```python
-# Where _eduvpn is the eduvpn.EduVPN class instance
-# This gets called when the Old_State_Example state is left
-# new_state is then the new state
-@_eduvpn.event.on("Old_State_Example", eduvpn.StateType.LEAVE)
-def example_leave(new_state: str, data: str)
-```
-To show how this can be done in practice, we will give an example in the next section.