tests: use github token in docstring tests

Author: machow

.github/workflows/ci.yml

@@ -33,6 +33,7 @@ jobs:
           AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
           AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
           AWS_REGION: "us-east-1"
+          GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
 
   test-rsconnect:
     name: "Test RSConnect"
@@ -53,6 +54,7 @@ jobs:
           make dev
         env:
           RSC_LICENSE: ${{ secrets.RSC_LICENSE }}
+          GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
 
       # NOTE: edited to run checks for python package
       - name: Run tests

pins/boards.py

@@ -568,7 +568,13 @@ class BoardManual(BaseBoard):
     Examples
     --------
     >>> import fsspec
-    >>> fs = fsspec.filesystem("github", org = "machow", repo = "pins-python")
+    >>> import os
+    >>> fs = fsspec.filesystem(
+    ...     "github",
+    ...     org = "machow",
+    ...     repo = "pins-python",
+    ...     token=os.environ.get("GITHUB_TOKEN")   # optional
+    ... )
 
     >>> pin_paths = {"df_csv": "df_csv/20220214T163720Z-9bfad"}
     >>> board = BoardManual("pins/tests/pins-compat", fs, pin_paths=pin_paths)

pins/constructors.py

@@ -150,7 +150,13 @@ def board_local(versioned=True, allow_pickle_read=None):
 
 
 def board_github(
-    org, repo, path="", versioned=True, cache=DEFAULT, allow_pickle_read=None
+    org,
+    repo,
+    path="",
+    token=None,
+    versioned=True,
+    cache=DEFAULT,
+    allow_pickle_read=None,
 ):
     """Returns a github pin board.
 
@@ -162,6 +168,8 @@ def board_github(
         Name of the repo.
     path:
         A subfolder in the github repo holding the board.
+    token:
+        An optional github token.
     **kwargs:
         Passed to the pins.board function.
 
@@ -173,7 +181,9 @@ def board_github(
     Examples
     --------
 
-    >>> board = board_github("machow", "pins-python", "pins/tests/pins-compat")
+    >>> import os
+    >>> gh_token = os.environ.get("GITHUB_TOKEN")
+    >>> board = board_github("machow", "pins-python", "pins/tests/pins-compat", gh_token)
     >>> board.pin_list()
     ['df_arrow', 'df_csv', 'df_rds', 'df_unversioned']
 

pins/tests/helpers.py

@@ -181,7 +181,8 @@ def create_tmp_board(self, src_board=None):
 
             shutil.copytree(src_board, p_root)
 
-            for pin_entry in p_root.glob("*/*"):
+            # note that glob order is technically arbitrary
+            for pin_entry in sorted(p_root.glob("*/*"), key=lambda x: str(x)):
                 # two key points:
                 #   1. username is required when putting content bundles up
                 #   2. the version must be removed.