Add auto token to gist

Author: martindurant

.github/workflows/main.yaml

@@ -22,6 +22,11 @@ jobs:
 
     env:
       CIRUN: true
+      GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+    permissions:
+      contents: read
+      gists: read
 
     steps:
       - name: Checkout

fsspec/implementations/gist.py

@@ -23,9 +23,9 @@ class GistFileSystem(AbstractFileSystem):
         If provided, fetch a particular revision of the gist. If omitted,
         the latest revision is used.
     username : str (optional)
-        GitHub username for authentication (required if token is given).
+        GitHub username for authentication .
     token : str (optional)
-        GitHub personal access token (required if username is given).
+        GitHub personal access token (required if username is given), or .
     timeout : (float, float) or float, optional
         Connect and read timeouts for requests (default 60s each).
     kwargs : dict
@@ -51,10 +51,8 @@ def __init__(
         self.gist_id = gist_id
         self.filenames = filenames
         self.sha = sha  # revision of the gist (optional)
-        if (username is None) ^ (token is None):
-            # Both or neither must be set
-            if username or token:
-                raise ValueError("Auth requires both username and token, or neither.")
+        if username is not None and token is None:
+            raise ValueError("User auth requires a token")
         self.username = username
         self.token = token
         self.request_kw = kwargs
@@ -69,6 +67,8 @@ def kw(self):
         """Auth parameters passed to 'requests' if we have username/token."""
         if self.username is not None and self.token is not None:
             return {"auth": (self.username, self.token), **self.request_kw}
+        elif self.token is not None:
+            return {"headers": {"Authorization": f"Bearer {self.token}"}}
         return self.request_kw
 
     def _fetch_gist_metadata(self):

fsspec/implementations/tests/test_gist.py

@@ -1,3 +1,4 @@
+import os
 import sys
 
 import pytest
@@ -8,13 +9,15 @@
 if sys.version_info[:2] != (3, 12):
     pytest.skip("Too many tests bust rate limit", allow_module_level=True)
 
+token = os.getenv("GH_TOKEN", None)
+
 
 @pytest.mark.parametrize(
     "gist_id,sha",
     [("2656908684d3965b80c2", "2fb2f12f332f7e242b1a2af1f41e30ddf99f24c7")],
 )
 def test_gist_public_all_files(gist_id, sha):
-    fs = fsspec.filesystem("gist", gist_id=gist_id, sha=sha)
+    fs = fsspec.filesystem("gist", gist_id=gist_id, sha=sha, token=token)
     # Listing
     all_files = fs.ls("")
     assert len(all_files) == 2
@@ -36,7 +39,9 @@ def test_gist_public_all_files(gist_id, sha):
     ],
 )
 def test_gist_public_one_file(gist_id, sha, file):
-    fs = fsspec.filesystem("gist", gist_id=gist_id, sha=sha, filenames=[file])
+    fs = fsspec.filesystem(
+        "gist", gist_id=gist_id, sha=sha, filenames=[file], token=token
+    )
     # Listing
     all_files = fs.ls("")
     assert len(all_files) == 1
@@ -59,7 +64,9 @@ def test_gist_public_one_file(gist_id, sha, file):
 )
 def test_gist_public_missing_file(gist_id, sha, file):
     with pytest.raises(FileNotFoundError):
-        fsspec.filesystem("gist", gist_id=gist_id, sha=sha, filenames=[file])
+        fsspec.filesystem(
+            "gist", gist_id=gist_id, sha=sha, filenames=[file], token=token
+        )
 
 
 @pytest.mark.parametrize(