ud3tn/doc/development/python_ud3tn_utils.md

# python-uD3TN-utils

The Python package uD3TN-utils is a utility library to simplify the interaction
with the uD3TN daemon within python applications.

The included `AAPClient` and `AAP2Client` classes enable user-friendly communication with the uD3TN
daemon via local or remote sockets using the [Application Agent Protocol (AAP)](../ud3tn_aap.md) and [AAP 2.0](../aap20.md).
Besides sending and receiving bundles, it is also possible to change the configuration of the uD3TN daemon's bundle forwarder via AAP or AAP 2.0 messages.
There is a [how-to guide](./how-to-build-an-aap20-client-in-python.md) explaining how to build a Python AAP 2.0 client using the Python module.

In addition to the AAP client interface, the package provides several easy-to-use utilities for interacting with a running µD3TN instance. Usage examples can be found, e.g., in the [Quick Start Guide](../posix_quick_start_guide.md).
Add existing documentation material to MkDocs This adds existing documentation files for ud3tn to the MkDocs skeleton. Signed-off-by: Fiona Fuchs <fiona.fuchs@d3tn.com> 2024-11-12 11:33:24 +01:00			`# python-uD3TN-utils`

			`The Python package uD3TN-utils is a utility library to simplify the interaction`
			`with the uD3TN daemon within python applications.`

doc: Add page how to build an AAP 2.0 client This adds a page explaining the use of the Python module to build an AAP 2.0 client and links it from the corresponding page. Signed-off-by: Felix Walter <felix.walter@d3tn.com> 2024-11-15 15:58:25 +01:00			The included `AAPClient` and `AAP2Client` classes enable user-friendly communication with the uD3TN
			`daemon via local or remote sockets using the [Application Agent Protocol (AAP)](../ud3tn_aap.md) and [AAP 2.0](../aap20.md).`
			`Besides sending and receiving bundles, it is also possible to change the configuration of the uD3TN daemon's bundle forwarder via AAP or AAP 2.0 messages.`
			`There is a [how-to guide](./how-to-build-an-aap20-client-in-python.md) explaining how to build a Python AAP 2.0 client using the Python module.`
Add existing documentation material to MkDocs This adds existing documentation files for ud3tn to the MkDocs skeleton. Signed-off-by: Fiona Fuchs <fiona.fuchs@d3tn.com> 2024-11-12 11:33:24 +01:00
doc: Add page how to build an AAP 2.0 client This adds a page explaining the use of the Python module to build an AAP 2.0 client and links it from the corresponding page. Signed-off-by: Felix Walter <felix.walter@d3tn.com> 2024-11-15 15:58:25 +01:00			`In addition to the AAP client interface, the package provides several easy-to-use utilities for interacting with a running µD3TN instance. Usage examples can be found, e.g., in the [Quick Start Guide](../posix_quick_start_guide.md).`