Skip to content

Commit

Permalink
Brief explanation of the add_recipient transformation in documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
dzoep committed Oct 21, 2024
1 parent 72317da commit 35fe4f1
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -111,6 +111,14 @@ writer.write()

### Adding Recipients for Serialization

For granting access to the encrypted container contents a filtering
wrapper is implemented which accepts underlying Crypt4GH container as
its source and allows for arbitrary transformations
on-the-fly. Currently only the `add_recipient` transformation is
available, which adds given public key as a new recipient to the
container by encrypting every readable packet for this recipient and
adding the newly encrypted version of given packet to the output.

```python
from oarepo_c4gh import Crypt4GHFilter

Expand Down

0 comments on commit 35fe4f1

Please sign in to comment.