Export key components of the library

didcomm/__init__.py

@@ -1 +1,53 @@
 __version__ = "0.3.0"
+
+# ignore 'Module imported but unused (F401)'
+# flake8: noqa: F401
+
+from didcomm.common.algorithms import AnonCryptAlg, AuthCryptAlg, SignAlg
+from didcomm.common.resolvers import ResolversConfig
+from didcomm.common.types import (
+ DIDCommMessageMediaTypes,
+ DIDCommMessageProtocolTypes,
+ DIDCommMessageTypes,
+ DIDDocServiceTypes,
+ VerificationMethodType,
+ VerificationMaterial,
+ VerificationMaterialFormat,
+)
+from didcomm.did_doc.did_doc import DIDDoc, DIDCommService, VerificationMethod
+from didcomm.did_doc.did_resolver import DIDResolver
+from didcomm.did_doc.did_resolver_in_memory import DIDResolverInMemory
+from didcomm.message import (
+ Attachment,
+ AttachmentDataBase64,
+ AttachmentDataJson,
+ AttachmentDataLinks,
+ FromPrior,
+ GenericMessage,
+ Message,
+)
+from didcomm import pack_encrypted as pack_encrypted_module
+from didcomm.pack_encrypted import (
+ pack_encrypted,
+ PackEncryptedConfig,
+ PackEncryptedParameters,
+ PackEncryptedResult,
+)
+from didcomm.pack_plaintext import (
+ pack_plaintext,
+ PackPlaintextParameters,
+ PackPlaintextResult,
+)
+from didcomm.pack_signed import pack_signed, PackSignedParameters, PackSignedResult
+from didcomm.protocols.routing.forward import (
+ is_forward,
+ unpack_forward,
+ wrap_in_forward,
+ ForwardBody,
+ ForwardMessage,
+ ForwardPackResult,
+ ForwardResult,
+)
+from didcomm.unpack import unpack, Metadata, UnpackConfig, UnpackResult
+from didcomm.secrets.secrets_resolver import Secret, SecretsResolver
+from didcomm.secrets.secrets_resolver_in_memory import SecretsResolverInMemory

tests/demo/test_demo.py

@@ -1,11 +1,14 @@
 import pytest as pytest
 
-from didcomm.message import Message
-from didcomm.pack_encrypted import pack_encrypted, PackEncryptedConfig
-from didcomm.pack_plaintext import pack_plaintext
-from didcomm.pack_signed import pack_signed
-from didcomm.protocols.routing.forward import unpack_forward
-from didcomm.unpack import unpack
+from didcomm import (
+ Message,
+ pack_encrypted,
+ PackEncryptedConfig,
+ pack_plaintext,
+ pack_signed,
+ unpack_forward,
+ unpack,
+)
 from tests.test_vectors.common import ALICE_DID, BOB_DID, CHARLIE_DID
 
 

tests/demo/test_demo_advanced_params.py

@@ -1,14 +1,15 @@
 import pytest as pytest
 
-from didcomm.common.algorithms import AnonCryptAlg
-from didcomm.message import Message
-from didcomm.pack_encrypted import (
+from didcomm import (
+ AnonCryptAlg,
+ Message,
  PackEncryptedConfig,
  PackEncryptedParameters,
  pack_encrypted,
+ unpack_forward,
+ unpack,
+ UnpackConfig,
 )
-from didcomm.protocols.routing.forward import unpack_forward
-from didcomm.unpack import unpack, UnpackConfig
 from tests.test_vectors.common import ALICE_DID, BOB_DID
 
 

tests/demo/test_demo_attachments.py

@@ -1,9 +1,14 @@
 import pytest as pytest
 
-from didcomm.message import Attachment, Message, AttachmentDataJson
-from didcomm.pack_encrypted import pack_encrypted, PackEncryptedConfig
-from didcomm.protocols.routing.forward import unpack_forward
-from didcomm.unpack import unpack
+from didcomm import (
+ Attachment,
+ Message,
+ AttachmentDataJson,
+ pack_encrypted,
+ PackEncryptedConfig,
+ unpack_forward,
+ unpack,
+)
 from tests.test_vectors.common import ALICE_DID, BOB_DID
 
 

tests/demo/test_demo_mediators.py

@@ -1,10 +1,14 @@
 import pytest as pytest
 
+from didcomm import (
+ Message,
+ pack_encrypted,
+ unpack_forward,
+ wrap_in_forward,
+ unpack,
+ UnpackConfig,
+)
 from didcomm.core.serialization import dict_to_json
-from didcomm.message import Message
-from didcomm.pack_encrypted import pack_encrypted
-from didcomm.protocols.routing.forward import unpack_forward, wrap_in_forward
-from didcomm.unpack import unpack, UnpackConfig
 from tests.test_vectors.common import ALICE_DID, BOB_DID
 
 

tests/demo/test_demo_rotate_keys.py

@@ -1,15 +1,16 @@
 import pytest as pytest
 
-from didcomm.common.resolvers import ResolversConfig
-from didcomm.message import Message, FromPrior
-from didcomm.pack_encrypted import (
+from didcomm import (
+ ResolversConfig,
+ Message,
+ FromPrior,
  pack_encrypted,
  PackEncryptedConfig,
  PackEncryptedParameters,
+ unpack_forward,
+ SecretsResolverInMemory,
+ unpack,
 )
-from didcomm.protocols.routing.forward import unpack_forward
-from didcomm.secrets.secrets_resolver_in_memory import SecretsResolverInMemory
-from didcomm.unpack import unpack
 from tests.test_vectors.common import CHARLIE_DID, BOB_DID, ALICE_DID
 from tests.test_vectors.secrets.mock_secrets_resolver_alice import (
  MockSecretsResolverAlice,

tests/performance/test_performance.py

@@ -3,8 +3,7 @@
 import pytest
 import pytest_asyncio
 
-from didcomm.pack_encrypted import PackEncryptedConfig, pack_encrypted
-from didcomm.unpack import unpack, UnpackConfig
+from didcomm import PackEncryptedConfig, pack_encrypted, unpack, UnpackConfig
 from tests.test_vectors.common import BOB_DID, ALICE_DID
 from tests.test_vectors.didcomm_messages.messages import TEST_MESSAGE
 

tests/test_vectors/common.py

@@ -2,7 +2,7 @@
 from typing import Any
 
 from didcomm.common.types import JSON
-from didcomm.unpack import Metadata
+from didcomm import Metadata
 
 ALICE_DID = "did:example:alice"
 BOB_DID = "did:example:bob"

tests/test_vectors/did_doc/did_doc_alice.py

@@ -1,11 +1,12 @@
 from authlib.common.encoding import json_dumps
 
-from didcomm.common.types import (
+from didcomm import (
  VerificationMethodType,
  VerificationMaterial,
  VerificationMaterialFormat,
+ VerificationMethod,
+ DIDDoc,
 )
-from didcomm.did_doc.did_doc import VerificationMethod, DIDDoc
 
 ALICE_VERIFICATION_METHOD_KEY_AGREEM_X25519_NOT_IN_SECRET = VerificationMethod(
  id="did:example:alice#key-x25519-not-in-secrets-1",

tests/test_vectors/did_doc/did_doc_bob.py

@@ -1,11 +1,13 @@
 from authlib.common.encoding import json_dumps
 
-from didcomm.common.types import (
+from didcomm import (
+ DIDDoc,
+ DIDCommService,
  VerificationMethodType,
  VerificationMaterial,
  VerificationMaterialFormat,
+ VerificationMethod,
 )
-from didcomm.did_doc.did_doc import VerificationMethod, DIDDoc, DIDCommService
 from didcomm.protocols.routing.forward import (
  PROFILE_DIDCOMM_V2,
  PROFILE_DIDCOMM_AIP2_ENV_RFC587,

tests/test_vectors/did_doc/did_doc_charlie.py

@@ -1,11 +1,13 @@
 from authlib.common.encoding import json_dumps
 
-from didcomm.common.types import (
+from didcomm import (
+ DIDDoc,
+ DIDCommService,
  VerificationMethodType,
  VerificationMaterial,
  VerificationMaterialFormat,
+ VerificationMethod,
 )
-from didcomm.did_doc.did_doc import DIDDoc, VerificationMethod, DIDCommService
 from didcomm.protocols.routing.forward import (
  PROFILE_DIDCOMM_V2,
  PROFILE_DIDCOMM_AIP2_ENV_RFC587,

tests/test_vectors/did_doc/did_doc_mediator1.py

@@ -1,11 +1,12 @@
 from authlib.common.encoding import json_dumps
 
-from didcomm.common.types import (
+from didcomm import (
+ DIDDoc,
  VerificationMethodType,
  VerificationMaterial,
  VerificationMaterialFormat,
+ VerificationMethod,
 )
-from didcomm.did_doc.did_doc import VerificationMethod, DIDDoc
 
 # FIXME build verification material
 # (currently it's a copy-paste from Bob's ones)

tests/test_vectors/did_doc/did_doc_mediator2.py

@@ -1,11 +1,13 @@
 from authlib.common.encoding import json_dumps
 
-from didcomm.common.types import (
+from didcomm import (
+ DIDDoc,
+ DIDCommService,
  VerificationMethodType,
  VerificationMaterial,
  VerificationMaterialFormat,
+ VerificationMethod,
 )
-from didcomm.did_doc.did_doc import VerificationMethod, DIDDoc, DIDCommService
 
 # FIXME build verification material
 # (currently it's a copy-paste from Bob's ones)

tests/test_vectors/did_doc/mock_did_resolver.py

@@ -1,4 +1,4 @@
-from didcomm.did_doc.did_resolver_in_memory import DIDResolverInMemory
+from didcomm import DIDResolverInMemory
 from tests.test_vectors.did_doc import (
  DID_DOC_ALICE_WITH_NO_SECRETS,
  DID_DOC_ALICE_SPEC_TEST_VECTORS,

tests/test_vectors/didcomm_messages/messages.py

@@ -1,7 +1,7 @@
 import copy
 
 from didcomm.errors import DIDCommValueError
-from didcomm.message import (
+from didcomm import (
  Message,
  Attachment,
  AttachmentDataBase64,

tests/test_vectors/didcomm_messages/spec/spec_test_vectors_anon_encrypted.py

@@ -1,7 +1,6 @@
 from authlib.common.encoding import json_dumps
 
-from didcomm.common.algorithms import AnonCryptAlg
-from didcomm.unpack import Metadata
+from didcomm import AnonCryptAlg, Metadata
 from tests.test_vectors.common import TTestVector
 
 TEST_ENCRYPTED_DIDCOMM_MESSAGE_ANON_XC20P_1 = json_dumps(

tests/test_vectors/didcomm_messages/spec/spec_test_vectors_auth_encrypted.py

@@ -1,7 +1,6 @@
 from authlib.common.encoding import json_dumps
 
-from didcomm.common.algorithms import AuthCryptAlg, SignAlg, AnonCryptAlg
-from didcomm.unpack import Metadata
+from didcomm import AuthCryptAlg, SignAlg, AnonCryptAlg, Metadata
 from tests.test_vectors.common import TTestVector
 
 TEST_ENCRYPTED_DIDCOMM_MESSAGE_AUTH_X25519 = json_dumps(

tests/test_vectors/didcomm_messages/spec/spec_test_vectors_plaintext.py

@@ -1,6 +1,6 @@
 from authlib.common.encoding import json_dumps
 
-from didcomm.unpack import Metadata
+from didcomm import Metadata
 
 PLAINTEXT_EXPECTED_METADATA = Metadata(
  encrypted=False,

tests/test_vectors/didcomm_messages/spec/spec_test_vectors_signed.py

@@ -2,8 +2,7 @@
 
 from authlib.common.encoding import json_dumps
 
-from didcomm.common.algorithms import SignAlg
-from didcomm.unpack import Metadata
+from didcomm import SignAlg, Metadata
 from tests.test_vectors.common import TTestVector
 
 TEST_SIGNED_DIDCOMM_MESSAGE_ALICE_KEY_1 = json_dumps(

tests/test_vectors/didcomm_messages/tests/test_vectors_plaintext_positive.py

@@ -1,6 +1,6 @@
 from authlib.common.encoding import json_dumps
 
-from didcomm.unpack import Metadata
+from didcomm import Metadata
 
 PLAINTEXT_EXPECTED_METADATA = Metadata(
  encrypted=False,

tests/test_vectors/secrets/mock_secrets_resolver.py

@@ -1,8 +1,7 @@
 from typing import List, Optional
 
 from didcomm.common.types import DID_URL
-from didcomm.secrets.secrets_resolver import Secret
-from didcomm.secrets.secrets_resolver_in_memory import SecretsResolverInMemory
+from didcomm import Secret, SecretsResolverInMemory
 
 
 class MockSecretsResolverInMemory(SecretsResolverInMemory):

tests/test_vectors/secrets/mock_secrets_resolver_alice.py

@@ -1,11 +1,11 @@
 from authlib.common.encoding import json_dumps
 
-from didcomm.common.types import (
+from didcomm import (
  VerificationMethodType,
  VerificationMaterial,
  VerificationMaterialFormat,
+ Secret,
 )
-from didcomm.secrets.secrets_resolver import Secret
 from tests.test_vectors.secrets.mock_secrets_resolver import MockSecretsResolverInMemory
 
 ALICE_SECRET_AUTH_KEY_ED25519 = Secret(

tests/test_vectors/secrets/mock_secrets_resolver_bob.py

@@ -1,11 +1,11 @@
 from authlib.common.encoding import json_dumps
 
-from didcomm.common.types import (
+from didcomm import (
  VerificationMethodType,
  VerificationMaterial,
  VerificationMaterialFormat,
+ Secret,
 )
-from didcomm.secrets.secrets_resolver import Secret
 from tests.test_vectors.secrets.mock_secrets_resolver import MockSecretsResolverInMemory
 
 BOB_SECRET_KEY_AGREEMENT_KEY_X25519_1 = Secret(

tests/test_vectors/secrets/mock_secrets_resolver_charlie.py

@@ -1,11 +1,11 @@
 from authlib.common.encoding import json_dumps
 
-from didcomm.common.types import (
+from didcomm import (
  VerificationMethodType,
  VerificationMaterial,
  VerificationMaterialFormat,
+ Secret,
 )
-from didcomm.secrets.secrets_resolver import Secret
 from tests.test_vectors.secrets.mock_secrets_resolver import MockSecretsResolverInMemory
 
 CHARLIE_SECRET_KEY_AGREEMENT_KEY_X25519 = Secret(

tests/test_vectors/secrets/mock_secrets_resolver_mediator1.py

@@ -1,11 +1,11 @@
 from authlib.common.encoding import json_dumps
 
-from didcomm.common.types import (
+from didcomm import (
  VerificationMethodType,
  VerificationMaterial,
  VerificationMaterialFormat,
+ Secret,
 )
-from didcomm.secrets.secrets_resolver import Secret
 from tests.test_vectors.secrets.mock_secrets_resolver import MockSecretsResolverInMemory
 
 # FIXME build verification material

tests/test_vectors/secrets/mock_secrets_resolver_mediator2.py

@@ -1,11 +1,11 @@
 from authlib.common.encoding import json_dumps
 
-from didcomm.common.types import (
+from didcomm import (
  VerificationMethodType,
  VerificationMaterial,
  VerificationMaterialFormat,
+ Secret,
 )
-from didcomm.secrets.secrets_resolver import Secret
 from tests.test_vectors.secrets.mock_secrets_resolver import MockSecretsResolverInMemory
 
 # FIXME build verification material