GlcoinCore/ud3tn
1
0
Fork 0
mirror of https://gitlab.com/d3tn/ud3tn.git synced 2026-08-13 12:33:27 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

python: Fix commands and information provided in package READMEs

Browse source 
The Python package README files were outdated. They now list the correct
installation commands and aside from that refer to the upstream docs.

Signed-off-by: Felix Walter <felix.walter@d3tn.com>
This commit is contained in:
Felix Walter 2025-07-23 14:30:34 +02:00
parent e6a5c7834c
commit 7249d09ff5
2 changed files with 16 additions and 24 deletions
Download patch file Download diff file Expand all files Collapse all files

7
pyd3tn/README.md
View file

@ -14,8 +14,7 @@ From source:
```sh
git clone https://gitlab.com/d3tn/ud3tn
cd pyd3tn
python setup.py install
pip install [-e] ud3tn/pyd3tn
```
From [PyPi](https://pypi.org/project/pyD3TN/) directly:
@ -27,7 +26,8 @@ pip install pyd3tn
## Development
pyD3TN is maintained as part of the µD3TN project and follows its development
processes. Please see the [µD3TN][ud3tn] repository for the code and further
processes. Please see the [µD3TN][ud3tn] repository and
[the µD3TN web documentation][ud3tn-docs] for further
information.
[rfc4838]: https://tools.ietf.org/html/rfc4838
@ -37,3 +37,4 @@ information.
[tcpclv3]: https://tools.ietf.org/html/rfc7242
[spp]: https://public.ccsds.org/Pubs/133x0b2e1.pdf
[ud3tn]: https://gitlab.com/d3tn/ud3tn
[ud3tn-docs]: https://d3tn.gitlab.io/ud3tn

33
python-ud3tn-utils/README.md
View file

@ -1,12 +1,12 @@
# python-uD3TN-utils
The Python package uD3TN-utils is a utility library to simplify the interaction
with the uD3TN daemon within python applications.
with the µD3TN daemon within python applications.
The included `AAPClient` enables user-friendly communication with the uD3TN
daemon via local or remote sockets using the Application Agent Protocol (AAP).
The included `AAP2Client` enables user-friendly communication with the µD3TN
daemon via local or remote sockets using the Application Agent Protocol 2 (AAP 2.0).
Besides sending and receiving bundles, it is also possible to change the
configuration of the uD3TN daemon via AAP messages.
configuration of the µD3TN daemon via AAP messages.
## Installation
@ -14,8 +14,7 @@ From source:
```sh
git clone https://gitlab.com/d3tn/ud3tn
cd python-ud3tn-utils
python setup.py install
pip install [-e] ud3tn/python-ud3tn-utils
```
From [PyPi](https://pypi.org/project/ud3tn-utils) directly:
@ -24,21 +23,13 @@ From [PyPi](https://pypi.org/project/ud3tn-utils) directly:
pip install ud3tn-utils
```
## Examples
```python
from ud3tn_utils.aap import AAPUnixClient
with AAPUnixClient() as aap_client:
aap_client.register()
aap_client.send_str(aap_client.eid(), "Hello World")
print(aap_client.receive())
```
## Development
pyD3TN is maintained as part of the µD3TN project and follows its development
processes. Please see the [µD3TN][ud3tn] repository for the code and further
information.
For examples on the usage of this library, check out the contained CLI tools
in the `aap/bin` (for the old AAP v1 protocol) and `aap2/bin` (for AAP 2.0)
subdirectories.
[ud3tn]: https://gitlab.com/d3tn/ud3tn
python-uD3TN-utils is maintained as part of the µD3TN project and follows its
development processes. Please see the [µD3TN](https://gitlab.com/d3tn/ud3tn)
repository and [the µD3TN web documentation](https://d3tn.gitlab.io/ud3tn)
for further information.