Add helpers to handle OAuth in a FastAPI app

docs/source/en/_toctree.yml

@@ -86,3 +86,5 @@
       title: Webhooks server
     - local: package_reference/serialization
       title: Serialization
+    - local: package_reference/oauth
+      title: OAuth

docs/source/en/package_reference/oauth.md

@@ -0,0 +1,22 @@
+## TO BE COMPLETED
+
+### attach_huggingface_oauth
+
+[[autodoc]] attach_huggingface_oauth
+
+### parse_huggingface_oauth
+
+[[autodoc]] parse_huggingface_oauth
+
+### OAuthOrgInfo
+
+[[autodoc]] OAuthOrgInfo
+
+### OAuthUserInfo
+
+[[autodoc]] OAuthUserInfo
+
+### OAuthInfo
+
+[[autodoc]] OAuthInfo
+

setup.py

@@ -31,6 +31,13 @@ def get_version() -> str:
     "aiohttp",  # for AsyncInferenceClient
 ]
 
+extras["oauth"] = [
+    "authlib>=1.3.2",  # minimum version to include https://github.com/lepture/authlib/pull/644
+    "fastapi",
+    "httpx",  # required for authlib but not included in its dependencies
+    "itsdangerous",  # required for starlette SessionMiddleware
+]
+
 extras["torch"] = [
     "torch",
     "safetensors[torch]",
@@ -59,6 +66,7 @@ def get_version() -> str:
 extras["testing"] = (
     extras["cli"]
     + extras["inference"]
+    + extras["oauth"]
     + [
         "jedi",
         "Jinja2",

src/huggingface_hub/__init__.py

@@ -70,6 +70,13 @@
         "logout",
         "notebook_login",
     ],
+    "_oauth": [
+        "OAuthInfo",
+        "OAuthOrgInfo",
+        "OAuthUserInfo",
+        "attach_huggingface_oauth",
+        "parse_huggingface_oauth",
+    ],
     "_snapshot_download": [
         "snapshot_download",
     ],
@@ -606,6 +613,13 @@ def __dir__():
         logout,  # noqa: F401
         notebook_login,  # noqa: F401
     )
+    from ._oauth import (
+        OAuthInfo,  # noqa: F401
+        OAuthOrgInfo,  # noqa: F401
+        OAuthUserInfo,  # noqa: F401
+        attach_huggingface_oauth,  # noqa: F401
+        parse_huggingface_oauth,  # noqa: F401
+    )
     from ._snapshot_download import snapshot_download  # noqa: F401
     from ._space_api import (
         SpaceHardware,  # noqa: F401