FEAT Add skops space creator app

.github/workflows/deploy-model-card-creator.yml

@@ -0,0 +1,46 @@
+name: Deploy-Space-Creator
+
+on:
+  - push
+  - pull_request
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  deploy-space-creator:
+    runs-on: "ubuntu-latest"
+    if: "github.repository == 'skops-dev/skops'"
+    # Timeout: https://stackoverflow.com/a/59076067/4521646
+    timeout-minutes: 5
+
+    steps:
+    - uses: actions/checkout@v3
+
+    - name: Set up Python
+      uses: actions/setup-python@v4
+      with:
+        python-version: "3.10"
+
+    - name: Install dependencies
+      run: |
+        pip install -e .[docs,tests]
+        python --version
+        pip --version
+        pip list
+      shell: bash
+
+    - name: Create test skops space creator app
+      # by default, deploy to skops CI
+      if: github.ref != 'refs/heads/main'
+      run: |
+        python spaces/deploy-skops-model-card-creator.py
+
+    - name: Create main skops space creator app
+      # if HF_HUB_TOKEN_SKLEARN, use that instead of skops CI orga
+      if: github.ref == 'refs/heads/main'
+      env:
+        HF_HUB_TOKEN_SKLEARN: ${{ secrets.HF_HUB_TOKEN_SKLEARN }}
+      run: |
+        python spaces/deploy-skops-model-card-creator.py

.pre-commit-config.yaml

@@ -27,4 +27,5 @@ repos:
     hooks:
     -   id: mypy
         args: [--config-file=pyproject.toml]
+        exclude: "spaces/"
         additional_dependencies: [types-requests>=2.28.5]

pyproject.toml

@@ -34,6 +34,6 @@ omit = [
 ]
 
 [tool.mypy]
-exclude = "(\\w+/)*test_\\w+\\.py$|old"
+exclude = "(\\w+/)*test_\\w+\\.py$|spaces/skops_model_card_creator|old"
 ignore_missing_imports = true
 no_implicit_optional = true

setup.py

@@ -80,6 +80,7 @@ def setup_package():
             "rich": min_deps.tag_to_packages["rich"],
         },
         include_package_data=True,
+        packages=["skops"],
     )
 
     setup(**package_data, **metadata)

spaces/README.md

@@ -0,0 +1,3 @@
+# Hugging Face Spaces
+
+Code and script for creating Hugging Face Spaces go here.

spaces/deploy-skops-model-card-creator.py

@@ -0,0 +1,49 @@
+# Deploying the app in skops_model_card_creator as a Hugging Face Space requires
+# the HF_HUB_TOKEN to be set as environment variable
+
+import os
+from pathlib import Path
+from uuid import uuid4
+
+from huggingface_hub import HfApi
+
+import skops
+import skops.hub_utils
+import skops.hub_utils.tests
+from skops.hub_utils.tests.common import HF_HUB_TOKEN
+
+token = os.environ.get("HF_HUB_TOKEN_SKLEARN")
+if token:
+    print("Deploying space to sklearn orga")
+else:
+    print("Deploying space to skops CI")
+    token = HF_HUB_TOKEN
+
+client = HfApi(token=token)
+user_name = client.whoami(token=token)["name"]
+repo_name = f"skops-model-card-creator-{uuid4()}"
+repo_id = f"{user_name}/{repo_name}"
+print(f"Creating and pushing to repo: {repo_id}")
+
+space_repo = Path(skops.__path__[0]).parent / "spaces" / "skops_model_card_creator"
+
+client.create_repo(
+    repo_id=repo_id,
+    token=token,
+    repo_type="space",
+    exist_ok=True,
+    space_sdk="streamlit",
+)
+out = client.upload_folder(
+    repo_id=repo_id,
+    path_in_repo=".",
+    folder_path=space_repo,
+    commit_message="Create skops-model-card-creator space",
+    token=token,
+    repo_type="space",
+    create_pr=False,
+)
+
+# link to main app, not to "<url>/tree/main/"
+url = out.rsplit("/", 3)[0]
+print(f"visit the space at {url}")