feat(python/bindings): improve documentation #748

msardara · 2025-09-25T09:43:47Z

Description

Document python bindings and improve examples annotations.

Type of Change

Checklist

I have read the contributing guidelines
Existing issues have been referenced (where applicable)
I have verified this change is not present in other open pull requests
Functionality is documented
All code style checks pass
New code contribution is covered by automated tests
All new and existing tests pass

Signed-off-by: Mauro Sardara <msardara@cisco.com>

github-actions · 2025-09-25T09:44:00Z

The latest Buf updates on your PR. Results from workflow Buf CI / buf (pull_request).

Build	Format	Lint	Breaking	Updated (UTC)
`✅ passed`	`✅ passed`	`✅ passed`	`✅ passed`	Sep 29, 2025, 7:25 AM

Signed-off-by: Mauro Sardara <msardara@cisco.com>

codecov · 2025-09-25T09:58:45Z

Codecov Report

❌ Patch coverage is 0% with 5 lines in your changes missing coverage. Please review.

Files with missing lines	Patch %	Lines
data-plane/python/bindings/src/pysession.rs	0.00%	5 Missing ⚠️

📢 Thoughts on this report? Let us know!

Signed-off-by: Mauro Sardara <msardara@cisco.com>

data-plane/python/bindings/examples/src/slim_bindings_examples/__init__.py

data-plane/python/bindings/examples/src/slim_bindings_examples/multicast.py

data-plane/python/bindings/examples/src/slim_bindings_examples/point_to_point.py

data-plane/python/bindings/slim_bindings/_slim_bindings.pyi

data-plane/python/bindings/slim_bindings/session.py

data-plane/python/bindings/slim_bindings/slim.py

data-plane/python/bindings/src/pysession.rs

data-plane/python/bindings/tests/test_identity.py

data-plane/python/bindings/README.md

Signed-off-by: Mauro Sardara <msardara@cisco.com>

…documentation-and-readme * origin/main: feat(python/bindings): improve publish function (#749)

Signed-off-by: Mauro Sardara <msardara@cisco.com>

data-plane/python/bindings/examples/README.md

Signed-off-by: Mauro Sardara <msardara@cisco.com>

Signed-off-by: Michele Papalini <micpapal@cisco.com>

data-plane/python/bindings/examples/README.md

data-plane/python/bindings/examples/src/slim_bindings_examples/point_to_point.py

data-plane/python/bindings/examples/src/slim_bindings_examples/multicast.py

data-plane/python/bindings/examples/src/slim_bindings_examples/common.py

Signed-off-by: Mauro Sardara <msardara@cisco.com>

micpapal

Approved with nits

…documentation-and-readme * origin/main: docs(python/bindings): add documentantion for sessions and example (#750) fix(python-bindings): remove destination_name property (#751)

Signed-off-by: Mauro Sardara <msardara@cisco.com>

msardara · 2025-09-29T07:29:56Z

Everything shohuld be fixed now 👌

## [0.6.0](slim-bindings-v0.5.0...slim-bindings-v0.6.0) (2025-10-09) ### ⚠ BREAKING CHANGES * session layer APIs updated. ### Features * improve point to point session with sender/receiver buffer ([#735](#735)) ([e6f65bb](e6f65bb)) * **multicast:** remove moderator parameter from configuration ([#739](#739)) ([464d523](464d523)) * **pysession:** expose session type, src and dst names ([#737](#737)) ([1c16ccc](1c16ccc)) * **python/bindings:** create a unique SLIM data-plane instance per process by default ([#819](#819)) ([728290c](728290c)) * **python/bindings:** improve documentation ([#748](#748)) ([88c43d8](88c43d8)) * **python/bindings:** improve publish function ([#749](#749)) ([85fd2ca](85fd2ca)) * **python/bindings:** remove request-reply API ([#677](#677)) ([65cec9d](65cec9d)) * **python/examples:** allow each participant to publish ([#778](#778)) ([0a28d9d](0a28d9d)) * refactor session receive() API ([#731](#731)) ([787d111](787d111)) * **session:** introduce session metadata ([#744](#744)) ([14528ee](14528ee)) ### Bug Fixes * **python-bindings:** remove destination_name property ([#751](#751)) ([ab651da](ab651da)) ### Documentation * **python/bindings:** add documentantion for sessions and example ([#750](#750)) ([04f1d0f](04f1d0f)) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please). Signed-off-by: Agntcy Build Bot <build@agntcy.io>

## [0.6.0](slim-bindings-examples-v0.1.1...slim-bindings-examples-v0.6.0) (2025-10-09) ### ⚠ BREAKING CHANGES * session layer APIs updated. ### Features * **multicast:** remove moderator parameter from configuration ([#739](#739)) ([464d523](464d523)) * **pysession:** expose session type, src and dst names ([#737](#737)) ([1c16ccc](1c16ccc)) * **python/bindings:** improve documentation ([#748](#748)) ([88c43d8](88c43d8)) * **python/bindings:** improve publish function ([#749](#749)) ([85fd2ca](85fd2ca)) * **python/bindings:** remove request-reply API ([#677](#677)) ([65cec9d](65cec9d)) * **python/bindings:** update multicast example readme ([#788](#788)) ([46ce07e](46ce07e)) * **python/examples:** allow each participant to publish ([#778](#778)) ([0a28d9d](0a28d9d)) * refactor session receive() API ([#731](#731)) ([787d111](787d111)) ### Bug Fixes * create a new JWKS file containg all keys from all trust domains ([#776](#776)) ([ae900d4](ae900d4)) * **python/examples:** correcly close multicast example ([#786](#786)) ([fa7de9c](fa7de9c)) ### Documentation * fix readmes for python bindings examples ([#764](#764)) ([4d29cd8](4d29cd8)) * **python/bindings:** add documentantion for sessions and example ([#750](#750)) ([04f1d0f](04f1d0f)) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please). --------- Signed-off-by: Agntcy Build Bot <build@agntcy.io> Signed-off-by: Mauro Sardara <msardara@cisco.com> Co-authored-by: Mauro Sardara <msardara@cisco.com>

feat(python/bindings): improve documentation

083d0d6

Signed-off-by: Mauro Sardara <msardara@cisco.com>

msardara requested a review from a team as a code owner September 25, 2025 09:43

msardara linked an issue Sep 25, 2025 that may be closed by this pull request

Improve examples documentation and readme #627

Closed

feat(python/bindings): improve documentation

d2c3a8b

Signed-off-by: Mauro Sardara <msardara@cisco.com>

msardara added 6 commits September 25, 2025 12:04

feat(python/bindings): improve documentation

d882c3d

Signed-off-by: Mauro Sardara <msardara@cisco.com>

feat(python/bindings): improve documentation

17f5253

Signed-off-by: Mauro Sardara <msardara@cisco.com>

feat(python/bindings): improve documentation

8f244e5

Signed-off-by: Mauro Sardara <msardara@cisco.com>

feat(python/bindings): improve documentation

2abe324

Signed-off-by: Mauro Sardara <msardara@cisco.com>

feat(python/bindings): improve documentation

3eb2d4a

Signed-off-by: Mauro Sardara <msardara@cisco.com>

feat(python/bindings): improve documentation

4f9b88e

Signed-off-by: Mauro Sardara <msardara@cisco.com>

micpapal reviewed Sep 25, 2025

View reviewed changes

data-plane/python/bindings/slim_bindings/_slim_bindings.pyi Show resolved Hide resolved

data-plane/python/bindings/slim_bindings/_slim_bindings.pyi Show resolved Hide resolved

micpapal reviewed Sep 25, 2025

View reviewed changes

data-plane/python/bindings/slim_bindings/_slim_bindings.pyi Show resolved Hide resolved

data-plane/python/bindings/slim_bindings/_slim_bindings.pyi Show resolved Hide resolved

micpapal reviewed Sep 25, 2025

View reviewed changes

data-plane/python/bindings/tests/test_identity.py Outdated Show resolved Hide resolved

data-plane/python/bindings/README.md Outdated Show resolved Hide resolved

data-plane/python/bindings/README.md Show resolved Hide resolved

msardara added 5 commits September 25, 2025 18:29

feat(python/bindings): improve documentation

38646c4

Signed-off-by: Mauro Sardara <msardara@cisco.com>

feat(python/bindings): improve documentation

51138f2

Signed-off-by: Mauro Sardara <msardara@cisco.com>

Merge remote-tracking branch 'origin/main' into 627-improve-examples-…

9af6995

…documentation-and-readme * origin/main: feat(python/bindings): improve publish function (#749)

feat(python/bindings): improve documentation

433abf3

Signed-off-by: Mauro Sardara <msardara@cisco.com>

feat(python/bindings): improve documentation

6eb5c69

Signed-off-by: Mauro Sardara <msardara@cisco.com>

micpapal reviewed Sep 26, 2025

View reviewed changes

msardara and others added 4 commits September 26, 2025 10:21

feat(python/bindings): improve documentation

fca8bb4

Signed-off-by: Mauro Sardara <msardara@cisco.com>

feat(python/bindings): improve documentation

30a8eea

Signed-off-by: Mauro Sardara <msardara@cisco.com>

feat(python/bindings): improve documentation

bd97973

Signed-off-by: Mauro Sardara <msardara@cisco.com>

fix: fix anycast example

d4bd49a

Signed-off-by: Michele Papalini <micpapal@cisco.com>

micpapal reviewed Sep 26, 2025

View reviewed changes

data-plane/python/bindings/examples/README.md Show resolved Hide resolved

data-plane/python/bindings/examples/README.md Outdated Show resolved Hide resolved

data-plane/python/bindings/examples/README.md Outdated Show resolved Hide resolved

micpapal reviewed Sep 26, 2025

View reviewed changes

data-plane/python/bindings/examples/src/slim_bindings_examples/point_to_point.py Outdated Show resolved Hide resolved

micpapal reviewed Sep 26, 2025

View reviewed changes

data-plane/python/bindings/examples/src/slim_bindings_examples/multicast.py Outdated Show resolved Hide resolved

micpapal reviewed Sep 26, 2025

View reviewed changes

data-plane/python/bindings/examples/src/slim_bindings_examples/common.py Outdated Show resolved Hide resolved

feat(python/bindings): improve documentation

cf3afe3

Signed-off-by: Mauro Sardara <msardara@cisco.com>

micpapal approved these changes Sep 26, 2025

View reviewed changes

msardara added 2 commits September 29, 2025 09:10

Merge remote-tracking branch 'origin/main' into 627-improve-examples-…

31619be

…documentation-and-readme * origin/main: docs(python/bindings): add documentantion for sessions and example (#750) fix(python-bindings): remove destination_name property (#751)

feat(python/bindings): improve documentation

dd4a39a

Signed-off-by: Mauro Sardara <msardara@cisco.com>

msardara merged commit 88c43d8 into main Sep 29, 2025
61 of 66 checks passed

msardara deleted the 627-improve-examples-documentation-and-readme branch September 29, 2025 08:03

This was referenced Sep 29, 2025

chore(main): release slim-bindings 1.0.0 #728

Closed

chore(main): release slim-bindings-examples 0.6.0 #729

Merged

build-agntcy mentioned this pull request Oct 7, 2025

chore(main): release slim-bindings 0.6.0 #789

Merged

build-agntcy mentioned this pull request Jan 6, 2026

chore(main): release slim-bindings-python 0.8.0 #1070

Closed

feat(python/bindings): improve documentation #748

feat(python/bindings): improve documentation #748

Uh oh!

Conversation

msardara commented Sep 25, 2025

Description

Type of Change

Checklist

Uh oh!

github-actions bot commented Sep 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codecov bot commented Sep 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

micpapal left a comment

Choose a reason for hiding this comment

Uh oh!

msardara commented Sep 29, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

github-actions bot commented Sep 25, 2025 •

edited

Loading

codecov bot commented Sep 25, 2025 •

edited

Loading