add doc in README

This commit is contained in:
Cayo Puigdefabregas 2024-05-28 17:38:27 +02:00
parent 1c694aa38a
commit 9ad325a377

110
README.md
View file

@ -0,0 +1,110 @@
# PyVckit
PyVckit is a library for:
- sign verifiable credentials
- verify verifiable credentials
- generate verifiable presentations
- verify verifiable submissions
This library is strongly inspired by [SpruceId didkit](https://github.com/spruceid/didkit) and aims to maintain compatibility with it.
For now the supported cryptography is only EdDSA with a signature Ed25519Signature2018.
# Install
For now the installation is from the repository:
```sh
python -m venv env
source env/bin/activate
git clone https://gitea.pangea.org/ereuse/pyvckit.git
cd pyvckit
pip install -r requirements.txt
pip install -e .
```
#Cli
The mode of use under the command line would be the following:
## generate a key pair:
```sh
python did.py -n keys > keypair.json
```
## generate a did identifier:
```sh
python did.py -n did -k keypair.json
```
## generate an example signed credential:
An example of a credential is generated, which is the one that appears in the credential_tmpl template in the file [templates.py](templates.py)
```sh
python sign_vc.py -k keypair.json > credential_signed.json
```
## verify a signed credential:
```sh
python verify_vc.py credential_signed.json
```
## generate a verifiable presentation:
```sh
python sign_vp.py -k keypair.json -c credential_signed.json > presentation_signed.json
```
## verify a verifiable presentation:
```sh
python verify_vp.py presentation_signed.json
```
# Use as a lib
In the tests you can find examples of use. Now I will explain the usual cases
## generate a key pair:
```python
from pyvckit.did import generate_keys
key = generate_keys()
```
## generate a did identifier:
```python
from pyvckit.did import generate_keys, generate_did
key = generate_keys()
did = generate_did(key)
```
## generate a signed credential:
Assuming **credential** is a valid credential.
**credential** is a string variable
```python
from pyvckit.did import generate_keys, generate_did, get_signing_key
from pyvckit.sign_vc import sign
key = generate_keys()
did = generate_did(key)
signing_key = get_signing_key(key)
vc = sign(credential, signing_key, did)
```
## verify a signed credential:
Assuming **vc** is a properly signed verifiable credential
```python
import json
from pyvckit.verify import verify_vc
verified = verify_vc(json.dumps(vc))
```
## generate a verifiable presentation:
```python
from pyvckit.did import generate_keys, generate_did, get_signing_key
from pyvckit.sign_vp import sign_vp
holder_key = generate_keys()
holder_did = generate_did(holder_key)
holder_signing_key = get_signing_key(holder_key)
vp = sign_vp(holder_signing_key, holder_did, vc_string)
```
## verify a verifiable presentation:
```python
from pyvckit.verify_vp import verify_vp
verified = verify_vp(json.dumps(vp))
```