File tree 2 files changed +28
-5
lines changed
2 files changed +28
-5
lines changed Original file line number Diff line number Diff line change 1
1
[package ]
2
- name = " lakers-python"
2
+ name = " lakers-python" # this will be the name of the package on pypi
3
3
edition = " 2021"
4
- version =" 0.1.0 "
4
+ version =" 0.1.2 "
5
5
repository.workspace = true
6
6
license.workspace = true
7
7
@@ -14,5 +14,5 @@ lakers-shared = { path = "../shared", features = ["python-bindings"] }
14
14
lakers-crypto = { path = " ../crypto" , default-features = false , features = [" rustcrypto" ] }
15
15
16
16
[lib ]
17
- name = " lakers" # this will be the name of the python package, and it must match the module name in lib.rs
17
+ name = " lakers" # this will be the name of the python package (as in `import lakers`) , and it must match the module name in lib.rs
18
18
crate-type = [" cdylib" ]
Original file line number Diff line number Diff line change 1
1
# Lakers Python
2
- Python wrapper for the ` lakers ` crate.
2
+ Python wrapper for the [ ` lakers ` crate] ( https://github.com/openwsn-berkeley/lakers ) .
3
+
4
+ # Installation and usage
5
+
6
+ ``` console
7
+ pip install lakers-python
8
+ ```
9
+
10
+ ``` python
11
+ import lakers
12
+
13
+ # generate a keypair
14
+ lakers.p256_generate_key_pair()
15
+
16
+ # instantiate a initiator and prepare EDHOC's message 1
17
+ initiator = lakers.EdhocInitiator()
18
+ message_1 = initiator.prepare_message_1(c_i = None , ead_1 = None )
19
+
20
+ # for more examples, see the tests in the repository
21
+ ```
22
+
23
+ # Development
3
24
4
25
To build and test:
5
26
``` bash
6
27
maturin develop
7
28
pytest
8
29
```
9
30
10
- # Requirements
31
+ ## Requirements
32
+
33
+ The maturin executable must be available. The recommended way is to install and use it in a virtual environment:
11
34
12
35
```
13
36
python3 -m venv .venv
You can’t perform that action at this time.
0 commit comments