change: update README.md by GitHub Actions

.github/tools/config.py

@@ -5,5 +5,18 @@ from model import Config
 UserName = Literal["default"]
 
 SPACE_CONFIG: Dict[UserName, Config] = {
-    "default": {"space_name": "example", "space_owner": "jy-raychen"}
+    "default": {
+        "space_name": "example",
+        "space_owner": "jy-raychen",
+        "space_readme": {
+            "title": "Hugging Face Maintain",
+            "emoji": "🏢",
+            "color_from": "blue",
+            "color_to": "indigo",
+            "sdk": "gradio",
+            "sdk_version": "4.36.0",
+            "app_file": "app.py",
+            "pinned": False,
+        },
+    }
 }

.github/tools/generate_readme.py

@@ -0,0 +1,29 @@
+import sys
+
+from config import SPACE_CONFIG
+from model import ReadMe, Space
+
+DEFAULT_USER = "jy-raychen"
+
+
+def readme_template(readme: ReadMe):
+    return f"""---
+title: {readme.title}
+emoji: {readme.emoji}
+colorFrom: {readme.color_from}
+colorTo: {readme.color_to}
+sdk: {readme.sdk}
+sdk_version: {readme.sdk_version}
+app_file: {readme.app_file}
+pinned: {readme.pinned}
+---
+
+Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference"""
+
+
+if __name__ == "__main__":
+    space = Space(SPACE_CONFIG["default"])
+
+    readme = readme_template(space.readme)
+    print(readme)
+    sys.exit(0)

.github/tools/model.py

@@ -1,15 +1,50 @@
 from typing import TypedDict
 
 
+class ReadMeConfig(TypedDict):
+    title: str
+    emoji: str
+    color_from: str
+    color_to: str
+    sdk: str
+    sdk_version: str
+    app_file: str
+    pinned: bool
+
+
+class ReadMe:
+    title: str
+    emoji: str
+    color_from: str
+    color_to: str
+    sdk: str
+    sdk_version: str
+    app_file: str
+    pinned: str
+
+    def __init__(self, readme_config: ReadMeConfig):
+        self.title = readme_config["title"]
+        self.emoji = readme_config["emoji"]
+        self.color_from = readme_config["color_from"]
+        self.color_to = readme_config["color_to"]
+        self.sdk = readme_config["sdk"]
+        self.sdk_version = readme_config["sdk_version"]
+        self.app_file = readme_config["app_file"]
+        self.pinned = str(readme_config["pinned"]).lower()
+
+
 class Config(TypedDict):
     space_name: str
     space_owner: str
+    space_readme: ReadMe
 
 
 class Space:
     name: str
     owner: str
+    readme: ReadMeConfig
 
     def __init__(self, config: Config):
         self.name = config["space_name"]
         self.owner = config["space_owner"]
+        self.readme = ReadMe(config["space_readme"])

.github/workflows/deploy-to-space.yaml

@@ -20,5 +20,14 @@ jobs:
         uses: actions/checkout@v4
         with:
           fetch-depth: '0'
+      - name: Update Repo README.md
+        run: |
+          python3 .github/tools/generate_readme.py > README.md
+          git config --global user.email "github-actions[bot]@users.noreply.github.com"
+          git config --global user.name "GitHub Actions[bot]"
+          git add ./README.md
+          if [[ `git status --porcelain` ]]; then
+            git commit -m "[skip ci] update README.md"
+          fi
       - name: Run deploy tool
         run: python3 .github/tools/deploy_to_space.py --branch_name="${{ github.ref_name }}" --user_token="${{ secrets.HF_TOKEN }}"