Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updates to the Read The Docs for 0.7.0/1 #1359

Merged
merged 5 commits into from
Aug 22, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions aries_cloudagent/messaging/jsonld/create_verify_data.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,7 @@
Contains the functions needed to produce and verify a json-ld signature.

This file was ported from
https://github.com/transmute-industries/Ed25519Signature2018/blob/master/
src/createVerifyData/index.js
https://github.com/transmute-industries/Ed25519Signature2018/blob/master/src/createVerifyData/index.js
"""

import datetime
Expand Down
60 changes: 35 additions & 25 deletions aries_cloudagent/resolver/routes.py
Original file line number Diff line number Diff line change
@@ -1,32 +1,42 @@
"""
Resolve did document admin routes.

"/resolver/resolve/{did}": {
"get": {
"responses": {
"200": {
"schema": {
"$ref": "#/definitions/DIDDoc"
},
"description": null
}
},
"parameters": [
{
"in": "path",
"name": "did",
"required": true,
"type": "string",
"pattern": "did:([a-z]+):((?:[a-zA-Z0-9._-]*:)*[a-zA-Z0-9._-]+)",
"description": "decentralize identifier(DID)",
"example": "did:ted:WgWxqztrNooG92RXvxSTWv"
}
],
"tags": [ "resolver" ],
"summary": "Retrieve doc for requested did",
"produces": [ "application/json" ]
"/resolver/resolve/{did}": {
"get": {
"responses": {
"200": {
"schema": {
"$ref": "#/definitions/DIDDoc"

},
"description": null

}

},
"parameters": [

{
"in": "path",
"name": "did",
"required": true,
"type": "string",
"pattern": "did:([a-z]+):((?:[a-zA-Z0-9._-]*:)*[a-zA-Z0-9._-]+)",
"description": "decentralize identifier(DID)",
"example": "did:ted:WgWxqztrNooG92RXvxSTWv"

}

],

"tags": [ "resolver" ],
"summary": "Retrieve doc for requested did",
"produces": [ "application/json" ]

}

}
}

"""

from aiohttp import web
Expand Down
48 changes: 24 additions & 24 deletions aries_cloudagent/vc/ld_proofs/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -28,34 +28,34 @@
from .check import get_properties_without_context

__all__ = [
sign,
verify,
derive,
ProofSet,
"sign",
"verify",
"derive",
"ProofSet",
# Proof purposes
ProofPurpose,
ControllerProofPurpose,
AssertionProofPurpose,
AuthenticationProofPurpose,
CredentialIssuancePurpose,
"ProofPurpose",
"ControllerProofPurpose",
"AssertionProofPurpose",
"AuthenticationProofPurpose",
"CredentialIssuancePurpose",
# Suites
LinkedDataProof,
LinkedDataSignature,
JwsLinkedDataSignature,
Ed25519Signature2018,
BbsBlsSignature2020,
BbsBlsSignatureProof2020,
"LinkedDataProof",
"LinkedDataSignature",
"JwsLinkedDataSignature",
"Ed25519Signature2018",
"BbsBlsSignature2020",
"BbsBlsSignatureProof2020",
# Key pairs
KeyPair,
WalletKeyPair,
"KeyPair",
"WalletKeyPair",
# Document Loaders
DocumentLoaderMethod,
DocumentLoader,
"DocumentLoaderMethod",
"DocumentLoader",
# Exceptions
LinkedDataProofException,
"LinkedDataProofException",
# Validation results
DocumentVerificationResult,
ProofResult,
PurposeResult,
get_properties_without_context,
"DocumentVerificationResult",
"ProofResult",
"PurposeResult",
"get_properties_without_context",
]
2 changes: 1 addition & 1 deletion aries_cloudagent/vc/ld_proofs/crypto/__init__.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
from .KeyPair import KeyPair
from .WalletKeyPair import WalletKeyPair

__all__ = [KeyPair, WalletKeyPair]
__all__ = ["KeyPair", "WalletKeyPair"]
2 changes: 1 addition & 1 deletion aries_cloudagent/vc/ld_proofs/document_loader.py
Original file line number Diff line number Diff line change
Expand Up @@ -112,4 +112,4 @@ def __call__(self, url: str, options: dict):

DocumentLoaderMethod = Callable[[str, dict], dict]

__all__ = [DocumentLoaderMethod, DocumentLoader]
__all__ = ["DocumentLoaderMethod", "DocumentLoader"]
10 changes: 5 additions & 5 deletions aries_cloudagent/vc/ld_proofs/purposes/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@
from .CredentialIssuancePurpose import CredentialIssuancePurpose

__all__ = [
ProofPurpose,
ControllerProofPurpose,
AssertionProofPurpose,
AuthenticationProofPurpose,
CredentialIssuancePurpose,
"ProofPurpose",
"ControllerProofPurpose",
"AssertionProofPurpose",
"AuthenticationProofPurpose",
"CredentialIssuancePurpose",
]
12 changes: 6 additions & 6 deletions aries_cloudagent/vc/ld_proofs/suites/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@
from .BbsBlsSignatureProof2020 import BbsBlsSignatureProof2020

__all__ = [
LinkedDataProof,
LinkedDataSignature,
JwsLinkedDataSignature,
Ed25519Signature2018,
BbsBlsSignature2020,
BbsBlsSignatureProof2020,
"LinkedDataProof",
"LinkedDataSignature",
"JwsLinkedDataSignature",
"Ed25519Signature2018",
"BbsBlsSignature2020",
"BbsBlsSignatureProof2020",
]
22 changes: 11 additions & 11 deletions aries_cloudagent/vc/tests/contexts/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,15 +12,15 @@


__all__ = [
DID_V1,
SECURITY_V1,
SECURITY_V2,
SECURITY_V3_UNSTABLE,
BBS_V1,
CREDENTIALS_V1,
CITIZENSHIP_V1,
VACCINATION_V1,
EXAMPLES_V1,
ODRL,
SCHEMA_ORG,
"DID_V1",
"SECURITY_V1",
"SECURITY_V2",
"SECURITY_V3_UNSTABLE",
"BBS_V1",
"CREDENTIALS_V1",
"CITIZENSHIP_V1",
"VACCINATION_V1",
"EXAMPLES_V1",
"ODRL",
"SCHEMA_ORG",
]
66 changes: 33 additions & 33 deletions aries_cloudagent/vc/tests/data/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -44,37 +44,37 @@
from .test_vc_document_nested_reveal import TEST_VC_DOCUMENT_NESTED_REVEAL

__all__ = [
BBS_NESTED_VC_FULL_REVEAL_DOCUMENT_MATTR,
BBS_NESTED_VC_MATTR,
BBS_NESTED_VC_REVEAL_DOCUMENT_MATTR,
BBS_PARTIAL_PROOF_NESTED_VC_MATTR,
BBS_PARTIAL_PROOF_VC_MATTR,
BBS_PROOF_VC_MATTR,
BBS_PROOF_NESTED_VC_MATTR,
BBS_SIGNED_VC_MATTR,
BBS_SIGNED_NESTED_VC_MATTR,
BBS_VC_MATTR,
BBS_VC_REVEAL_DOCUMENT_MATTR,
TEST_LD_DOCUMENT_BAD_SIGNED_BBS,
TEST_LD_DOCUMENT_SIGNED_BBS,
TEST_LD_DOCUMENT_BAD_SIGNED_ED25519,
TEST_LD_DOCUMENT_SIGNED_ED25519,
TEST_LD_DOCUMENT,
TEST_LD_DOCUMENT_REVEAL,
TEST_LD_DOCUMENT_REVEAL_ALL,
TEST_LD_DOCUMENT_PROOF_BBS,
TEST_LD_DOCUMENT_PARTIAL_PROOF_BBS,
TEST_LD_DOCUMENT_BAD_PARTIAL_PROOF_BBS,
TEST_VC_DOCUMENT_NESTED_PARTIAL_PROOF_BBS,
TEST_VC_DOCUMENT_NESTED_PROOF_BBS,
TEST_VC_DOCUMENT_NESTED_SIGNED_BBS,
TEST_VC_DOCUMENT_NESTED,
TEST_VC_DOCUMENT_PARTIAL_PROOF_BBS,
TEST_VC_DOCUMENT_REVEAL,
TEST_VC_DOCUMENT_SIGNED_BBS,
TEST_VC_DOCUMENT_SIGNED_ED25519,
TEST_VC_DOCUMENT,
TEST_VC_DOCUMENT_SIGNED_DID_KEY_ED25519,
TEST_VC_DOCUMENT_DID_KEY_ED25519,
TEST_VC_DOCUMENT_NESTED_REVEAL,
"BBS_NESTED_VC_FULL_REVEAL_DOCUMENT_MATTR",
"BBS_NESTED_VC_MATTR",
"BBS_NESTED_VC_REVEAL_DOCUMENT_MATTR",
"BBS_PARTIAL_PROOF_NESTED_VC_MATTR",
"BBS_PARTIAL_PROOF_VC_MATTR",
"BBS_PROOF_VC_MATTR",
"BBS_PROOF_NESTED_VC_MATTR",
"BBS_SIGNED_VC_MATTR",
"BBS_SIGNED_NESTED_VC_MATTR",
"BBS_VC_MATTR",
"BBS_VC_REVEAL_DOCUMENT_MATTR",
"TEST_LD_DOCUMENT_BAD_SIGNED_BBS",
"TEST_LD_DOCUMENT_SIGNED_BBS",
"TEST_LD_DOCUMENT_BAD_SIGNED_ED25519",
"TEST_LD_DOCUMENT_SIGNED_ED25519",
"TEST_LD_DOCUMENT",
"TEST_LD_DOCUMENT_REVEAL",
"TEST_LD_DOCUMENT_REVEAL_ALL",
"TEST_LD_DOCUMENT_PROOF_BBS",
"TEST_LD_DOCUMENT_PARTIAL_PROOF_BBS",
"TEST_LD_DOCUMENT_BAD_PARTIAL_PROOF_BBS",
"TEST_VC_DOCUMENT_NESTED_PARTIAL_PROOF_BBS",
"TEST_VC_DOCUMENT_NESTED_PROOF_BBS",
"TEST_VC_DOCUMENT_NESTED_SIGNED_BBS",
"TEST_VC_DOCUMENT_NESTED",
"TEST_VC_DOCUMENT_PARTIAL_PROOF_BBS",
"TEST_VC_DOCUMENT_REVEAL",
"TEST_VC_DOCUMENT_SIGNED_BBS",
"TEST_VC_DOCUMENT_SIGNED_ED25519",
"TEST_VC_DOCUMENT",
"TEST_VC_DOCUMENT_SIGNED_DID_KEY_ED25519",
"TEST_VC_DOCUMENT_DID_KEY_ED25519",
"TEST_VC_DOCUMENT_NESTED_REVEAL",
]
8 changes: 4 additions & 4 deletions aries_cloudagent/vc/tests/dids/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@
from .did_sov_QqEfJxe752NCmWqR5TssZ5 import DID_SOV_QqEfJxe752NCmWqR5TssZ5

__all__ = [
DID_z6Mkgg342Ycpuk263R9d8Aq6MUaxPn1DDeHyGo38EefXmgDL,
DID_zUC72Q7XD4PE4CrMiDVXuvZng3sBvMmaGgNeTUJuzavH2BS7ThbHL9FhsZM9QYY5fqAQ4MB8M9oudz3tfuaX36Ajr97QRW7LBt6WWmrtESe6Bs5NYzFtLWEmeVtvRYVAgjFcJSa,
DID_EXAMPLE_48939859,
DID_SOV_QqEfJxe752NCmWqR5TssZ5,
"DID_z6Mkgg342Ycpuk263R9d8Aq6MUaxPn1DDeHyGo38EefXmgDL",
"DID_zUC72Q7XD4PE4CrMiDVXuvZng3sBvMmaGgNeTUJuzavH2BS7ThbHL9FhsZM9QYY5fqAQ4MB8M9oudz3tfuaX36Ajr97QRW7LBt6WWmrtESe6Bs5NYzFtLWEmeVtvRYVAgjFcJSa",
"DID_EXAMPLE_48939859",
"DID_SOV_QqEfJxe752NCmWqR5TssZ5",
]
24 changes: 12 additions & 12 deletions aries_cloudagent/vc/vc_ld/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -11,16 +11,16 @@
)

__all__ = [
issue,
verify_presentation,
verify_credential,
create_presentation,
sign_presentation,
derive_credential,
PresentationVerificationResult,
VerifiableCredential,
LDProof,
LinkedDataProofSchema,
CredentialSchema,
VerifiableCredentialSchema,
"issue",
"verify_presentation",
"verify_credential",
"create_presentation",
"sign_presentation",
"derive_credential",
"PresentationVerificationResult",
"VerifiableCredential",
"LDProof",
"LinkedDataProofSchema",
"CredentialSchema",
"VerifiableCredentialSchema",
]
10 changes: 5 additions & 5 deletions aries_cloudagent/vc/vc_ld/models/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@
)

__all__ = [
VerifiableCredential,
CredentialSchema,
VerifiableCredentialSchema,
LDProof,
LinkedDataProofSchema,
"VerifiableCredential",
"CredentialSchema",
"VerifiableCredentialSchema",
"LDProof",
"LinkedDataProofSchema",
]
2 changes: 1 addition & 1 deletion aries_cloudagent/vc/vc_ld/verify.py
Original file line number Diff line number Diff line change
Expand Up @@ -183,4 +183,4 @@ async def verify_presentation(
return PresentationVerificationResult(verified=False, errors=[e])


__all__ = [verify_presentation, verify_credential]
__all__ = ["verify_presentation", "verify_credential"]
11 changes: 10 additions & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,6 @@
"aiohttp_cors",
"aiohttp",
"aiohttp_apispec",
"marshmallow",
"base58",
"msgpack",
"pytest",
Expand All @@ -34,6 +33,16 @@
"multicodec",
"configargparse",
"pyld",
"pydid",
"aries_askar",
"indy_vdr",
"aioredis",
"deepmerge",
"ecdsa",
"indy_credx",
"dateutil",
"jsonpath_ng",
"unflatten",
]

# "aries_cloudagent.tests.test_conductor",
Expand Down
26 changes: 26 additions & 0 deletions docs/generated/aries_cloudagent.askar.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
aries\_cloudagent.askar package
===============================

.. automodule:: aries_cloudagent.askar
:members:
:undoc-members:
:show-inheritance:

Submodules
----------

aries\_cloudagent.askar.profile module
--------------------------------------

.. automodule:: aries_cloudagent.askar.profile
:members:
:undoc-members:
:show-inheritance:

aries\_cloudagent.askar.store module
------------------------------------

.. automodule:: aries_cloudagent.askar.store
:members:
:undoc-members:
:show-inheritance:
Loading