Skip to content

Commit

Permalink
Pre-release 0.4: support for Crypt4GH header.
Browse files Browse the repository at this point in the history
- add example usage to documentation
- update version to 0.4
- ensure packet_header documentation is generated
  • Loading branch information
dzoep committed Aug 24, 2024
1 parent 1138008 commit 673b94a
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 1 deletion.
2 changes: 2 additions & 0 deletions docs/implementation.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,4 +22,6 @@ Crypt4GH Container

::: oarepo_c4gh.crypt4gh.header

::: oarepo_c4gh.crypt4gh.header_packet

::: oarepo_c4gh.crypt4gh.util
12 changes: 12 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,3 +45,15 @@ Once the key is loaded, one can always obtain its public part:
print(my_key.get_public_key())
print(my_secret_key.get_public_key())
```

### Loading Crypt4GH Containers

With secret key loaded, initializing Crypt4GH container for reading
with actual container data is straightforward:

```python
from oarepo_c4gh import Crypt4GH

with open("hello.txt.c4gh") as f:
crypt4gh = Crypt4GH(my_secret_key, f)
```
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[project]
name = "oarepo_c4gh"
version = "0.3"
version = "0.4"
authors = [
{ name = "Dominik Pantůček", email = "[email protected]" }
]
Expand Down

0 comments on commit 673b94a

Please sign in to comment.