MarshalX · MarshalX · Dec 23, 2023 · Dec 22, 2023 · Dec 22, 2023 · Dec 22, 2023
diff --git a/.coveragerc b/.coveragerc
@@ -0,0 +1,4 @@
+[run]
+omit =
+    # ignore all test cases in tests/
+    tests/*
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -30,6 +30,9 @@ jobs:
             files.pythonhosted.org
             install.python-poetry.org
             pypi.org
+            *.atproto.blue
+            *.marshal.dev
+            plc.directory
 
       - name: Checkout repository.
         uses: actions/checkout@v4

diff --git a/CHANGES.md b/CHANGES.md
@@ -4,11 +4,8 @@
 
 **21.12.2023**
 
-# ❗Breaking changes
+**❗Breaking changes:** SDK was split into many packages. This affects imports in your codebase. [Read more](https://atproto.blue/en/latest/readme.content.html#sdk-structure)
 
-SDK was split into many packages. This affects imports in your codebase. [Read more](https://atproto.blue/en/latest/readme.content.html#sdk-structure)
-
-## What's Changed
 * New SDK structure by @MarshalX in https://github.com/MarshalX/atproto/pull/214 and https://github.com/MarshalX/atproto/pull/216
 * Fix decoding of CAR root by @MarshalX in https://github.com/MarshalX/atproto/pull/213
 * Fix parsing of BlobRef in CBOR by @MarshalX in https://github.com/MarshalX/atproto/pull/215

diff --git a/README.md b/README.md
@@ -70,7 +70,9 @@ if __name__ == '__main__':
 
 🍿 [Example project with custom feed generator](https://github.com/MarshalX/bluesky-feed-generator)
 
-🔥 [Firehose data streaming is available!](https://atproto.blue/en/latest/firehose.html)
+🔥 [Firehose data streaming is available](https://atproto.blue/en/latest/firehose.html)
+
+🌐 [Identity resolvers for DID and Handle](https://atproto.blue/en/latest/atproto_identity/identity.html)
 
 ### Introduction
 
@@ -138,13 +140,17 @@ Useful links to continue:
 ### SDK structure
 
 The SDK is built upon the following components:
-- `atproto` — the package that contains import shortcuts to other packages.
-- `atproto_cli` — the package that contains the CLI tool to generate code.
-- `atproto_client` — the package that contains the XRPC Client, data models, and utils like rich text helper.
-- `atproto_codegen` — the package that contains the code generator of models, clients, and namespaces.
-- `atproto_core` — the package that contains the core of the SDK. Base class of exceptions, tools to work with NSID, AT URI Schemes, CID, and CAR files.
-- `atproto_firehose` — the package that contains the Firehose (data streaming) client and models.
-- `atproto_lexicon` — the package that contains the lexicon parser.
+
+| Package            | Description                                                                                                                           |
+|--------------------|---------------------------------------------------------------------------------------------------------------------------------------|
+| `atproto`          | The package that contains import shortcuts to other packages.                                                                         |
+| `atproto_cli`      | The package that contains the CLI tool to generate code.                                                                              |
+| `atproto_client`   | The package that contains the XRPC Client, data models, and utils like rich text helper.                                              |
+| `atproto_codegen`  | The package that contains the code generator of models, clients, and namespaces.                                                      |
+| `atproto_core`     | The package that contains the core of the SDK. Base class of exceptions, tools to work with NSID, AT URI Schemes, CID, and CAR files. |
+| `atproto_firehose` | The package that contains the Firehose (data streaming) client and models.                                                            |
+| `atproto_identity` | The package that contains the identity resolvers for DID and Handle.                                                                  |
+| `atproto_lexicon`  | The package that contains the lexicon parser.                                                                                         |
 
 I highly recommend you to use the `atproto` package to import everything that you need. 
 It contains shortcuts to all other packages.

diff --git a/docs/source/atproto/atproto_core.did_doc.did_doc.rst b/docs/source/atproto/atproto_core.did_doc.did_doc.rst
@@ -0,0 +1,7 @@
+atproto\_core.did\_doc.did\_doc
+===============================
+
+.. automodule:: atproto_core.did_doc.did_doc
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/atproto/atproto_core.did_doc.rst b/docs/source/atproto/atproto_core.did_doc.rst
@@ -0,0 +1,15 @@
+atproto\_core.did\_doc
+======================
+
+.. automodule:: atproto_core.did_doc
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Submodules
+----------
+
+.. toctree::
+   :maxdepth: 4
+
+   atproto_core.did_doc.did_doc
diff --git a/docs/source/atproto/atproto_core.rst b/docs/source/atproto/atproto_core.rst
@@ -15,6 +15,7 @@ Subpackages
    atproto_core.car
    atproto_core.cbor
    atproto_core.cid
+   atproto_core.did_doc
    atproto_core.nsid
    atproto_core.uri
 

diff --git a/docs/source/atproto/atproto_identity.cache.base_cache.rst b/docs/source/atproto/atproto_identity.cache.base_cache.rst
@@ -0,0 +1,7 @@
+atproto\_identity.cache.base\_cache
+===================================
+
+.. automodule:: atproto_identity.cache.base_cache
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/atproto/atproto_identity.cache.in_memory_cache.rst b/docs/source/atproto/atproto_identity.cache.in_memory_cache.rst
@@ -0,0 +1,7 @@
+atproto\_identity.cache.in\_memory\_cache
+=========================================
+
+.. automodule:: atproto_identity.cache.in_memory_cache
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/atproto/atproto_identity.cache.models.rst b/docs/source/atproto/atproto_identity.cache.models.rst
@@ -0,0 +1,7 @@
+atproto\_identity.cache.models
+==============================
+
+.. automodule:: atproto_identity.cache.models
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/atproto/atproto_identity.cache.rst b/docs/source/atproto/atproto_identity.cache.rst
@@ -0,0 +1,17 @@
+atproto\_identity.cache
+=======================
+
+.. automodule:: atproto_identity.cache
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Submodules
+----------
+
+.. toctree::
+   :maxdepth: 4
+
+   atproto_identity.cache.base_cache
+   atproto_identity.cache.in_memory_cache
+   atproto_identity.cache.models
diff --git a/docs/source/atproto/atproto_identity.did.atproto_data.rst b/docs/source/atproto/atproto_identity.did.atproto_data.rst
@@ -0,0 +1,7 @@
+atproto\_identity.did.atproto\_data
+===================================
+
+.. automodule:: atproto_identity.did.atproto_data
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/atproto/atproto_identity.did.models.rst b/docs/source/atproto/atproto_identity.did.models.rst
@@ -0,0 +1,7 @@
+atproto\_identity.did.models
+============================
+
+.. automodule:: atproto_identity.did.models
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/atproto/atproto_identity.did.resolver.rst b/docs/source/atproto/atproto_identity.did.resolver.rst
@@ -0,0 +1,7 @@
+atproto\_identity.did.resolver
+==============================
+
+.. automodule:: atproto_identity.did.resolver
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/atproto/atproto_identity.did.resolvers.base_resolver.rst b/docs/source/atproto/atproto_identity.did.resolvers.base_resolver.rst
@@ -0,0 +1,7 @@
+atproto\_identity.did.resolvers.base\_resolver
+==============================================
+
+.. automodule:: atproto_identity.did.resolvers.base_resolver
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/atproto/atproto_identity.did.resolvers.plc_resolver.rst b/docs/source/atproto/atproto_identity.did.resolvers.plc_resolver.rst
@@ -0,0 +1,7 @@
+atproto\_identity.did.resolvers.plc\_resolver
+=============================================
+
+.. automodule:: atproto_identity.did.resolvers.plc_resolver
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/atproto/atproto_identity.did.resolvers.rst b/docs/source/atproto/atproto_identity.did.resolvers.rst
@@ -0,0 +1,17 @@
+atproto\_identity.did.resolvers
+===============================
+
+.. automodule:: atproto_identity.did.resolvers
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Submodules
+----------
+
+.. toctree::
+   :maxdepth: 4
+
+   atproto_identity.did.resolvers.base_resolver
+   atproto_identity.did.resolvers.plc_resolver
+   atproto_identity.did.resolvers.web_resolver
diff --git a/docs/source/atproto/atproto_identity.did.resolvers.web_resolver.rst b/docs/source/atproto/atproto_identity.did.resolvers.web_resolver.rst
@@ -0,0 +1,7 @@
+atproto\_identity.did.resolvers.web\_resolver
+=============================================
+
+.. automodule:: atproto_identity.did.resolvers.web_resolver
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/atproto/atproto_identity.did.rst b/docs/source/atproto/atproto_identity.did.rst
@@ -0,0 +1,25 @@
+atproto\_identity.did
+=====================
+
+.. automodule:: atproto_identity.did
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   atproto_identity.did.resolvers
+
+Submodules
+----------
+
+.. toctree::
+   :maxdepth: 4
+
+   atproto_identity.did.atproto_data
+   atproto_identity.did.models
+   atproto_identity.did.resolver
diff --git a/docs/source/atproto/atproto_identity.exceptions.rst b/docs/source/atproto/atproto_identity.exceptions.rst
@@ -0,0 +1,7 @@
+atproto\_identity.exceptions
+============================
+
+.. automodule:: atproto_identity.exceptions
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/atproto/atproto_identity.handle.resolver.rst b/docs/source/atproto/atproto_identity.handle.resolver.rst
@@ -0,0 +1,7 @@
+atproto\_identity.handle.resolver
+=================================
+
+.. automodule:: atproto_identity.handle.resolver
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/atproto/atproto_identity.handle.rst b/docs/source/atproto/atproto_identity.handle.rst
@@ -0,0 +1,15 @@
+atproto\_identity.handle
+========================
+
+.. automodule:: atproto_identity.handle
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Submodules
+----------
+
+.. toctree::
+   :maxdepth: 4
+
+   atproto_identity.handle.resolver
diff --git a/docs/source/atproto/atproto_identity.resolver.rst b/docs/source/atproto/atproto_identity.resolver.rst
@@ -0,0 +1,7 @@
+atproto\_identity.resolver
+==========================
+
+.. automodule:: atproto_identity.resolver
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/atproto/atproto_identity.rst b/docs/source/atproto/atproto_identity.rst
@@ -0,0 +1,26 @@
+atproto\_identity
+=================
+
+.. automodule:: atproto_identity
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   atproto_identity.cache
+   atproto_identity.did
+   atproto_identity.handle
+
+Submodules
+----------
+
+.. toctree::
+   :maxdepth: 4
+
+   atproto_identity.exceptions
+   atproto_identity.resolver
diff --git a/docs/source/atproto/modules.rst b/docs/source/atproto/modules.rst
@@ -10,5 +10,6 @@ packages
    atproto_codegen
    atproto_core
    atproto_firehose
+   atproto_identity
    atproto_lexicon
    atproto_server
diff --git a/docs/source/atproto_identity/cache.rst b/docs/source/atproto_identity/cache.rst
@@ -0,0 +1,38 @@
+Cache
+=====
+
+Cache could be used to store previously resolved DID Documents. SDK provides ``DidInMemoryCache`` and ``DidBaseCache`` classes.
+
+``DidInMemoryCache`` is a simple implementation of ``DidBaseCache`` that stores data in memory. Feel free to use it as real cache or as a reference implementation.
+
+``DidBaseCache`` is an abstract class that could be used to implement custom cache. Please note that there is 2 base classes. One for synchronous and another for asynchronous cache.
+
+Here is an example of how to use ``DidInMemoryCache`` with ``IdResolver``:
+
+.. code-block:: python
+
+    from atproto import DidInMemoryCache, IdResolver  # for async AsyncDidInMemoryCache and AsyncIdResolver
+
+    cache = DidInMemoryCache()
+    resolver = IdResolver(cache=cache)
+    did_doc = resolver.did.resolve('did:web:feed.atproto.blue')
+
+    # Now did_document is cached and could be retrieved without network request
+    did_doc = resolver.did.resolve('did:web:feed.atproto.blue')
+
+    # Clear cache
+    cache.clear()
+
+    # Now did_document is not cached and will be retrieved with network request
+    did_doc = resolver.did.resolve('did:web:feed.atproto.blue')
+
+
+.. automodule:: atproto_identity.cache.in_memory_cache
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. automodule:: atproto_identity.cache.base_cache
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/atproto_identity/did_resolver.rst b/docs/source/atproto_identity/did_resolver.rst
@@ -0,0 +1,7 @@
+DID Resolver
+============
+
+.. automodule:: atproto_identity.did.resolver
+   :members:
+   :undoc-members:
+   :inherited-members:
diff --git a/docs/source/atproto_identity/handle_resolver.rst b/docs/source/atproto_identity/handle_resolver.rst
@@ -0,0 +1,7 @@
+Handle Resolver
+===============
+
+.. automodule:: atproto_identity.handle.resolver
+   :members:
+   :undoc-members:
+   :inherited-members:
diff --git a/docs/source/atproto_identity/id_resolver.rst b/docs/source/atproto_identity/id_resolver.rst
@@ -0,0 +1,7 @@
+ID Resolver
+===========
+
+.. automodule:: atproto_identity.resolver
+   :members:
+   :undoc-members:
+   :inherited-members: