Readme-based configuration

README.md

@@ -7,9 +7,35 @@ sdk: gradio
 sdk_version: 4.7.1
 app_file: app.py
 pinned: false
+space_ci:
+   trusted_authors:
+      - clefourrier
+      # ^ Only PRs from trusted authors are deployed in an ephemeral Space.
+      # Space owners are automatically trusted.
+      # It is possible to manually trust other authors by adding them as a list.
+   private: auto
+      # ^ Can be 'true', 'false' or 'auto'. If 'auto', the ephemeral Spaces will have same
+      # visibility as the main Space.
+   variables: auto
+      # ^ By default ('auto'), all variables from the main Space are copied to the ephemeral Space.
+      # Otherwise, you can define a key-value mapping with variables to set.
+      # Variables are injected as environment variable in the ephemeral Space and are public for anyone landing on the Space.
+   secrets:
+      - HF_TOKEN
+      # ^ A list of secrets that must be copied from the main Space to the ephemeral Spaces.
+      # Secrets are injected as environment variable in the ephemeral Space.
+      # Be careful with the 'trusted_authors' list when setting secrets. 
+   hardware: cpu-basic
+      # ^ Defines which hardware to assign to the ephemeral Space.
+      # Can be set to 'auto' to assign the same hardware as the main Space.
+      # Defaults to 'cpu-basic' (free).
+   storage: null
+      # ^ Defines which storage to assign to the ephemeral Space.
+      # Can be set to 'auto' to assign the same storage as the main Space.
+      # Defaults to no storage (free).
 ---
 
-# Build a CI for your Spaces 🚀
+# Configure a CI for your Spaces 🚀
 
 **Gradio Space CI** is a plugin (and package) to create ephemeral Spaces for each PR opened on your Space repo.
 The goal is to foster community contributions by making the review process as lean as possible.
@@ -42,10 +68,9 @@ Add the following line to it:
 
 ```bash
 # requirements.txt
-gradio-space-ci@git+https://huggingface.co/spaces/Wauplin/gradio-space-ci
+gradio-space-ci @ git+https://huggingface.co/spaces/Wauplin/gradio-space-ci@0.1.3
 ```
 
-
 ### 2. Add a user token as `HF_TOKEN` secret
 
 1. Go to your [user settings page](https://huggingface.co/settings/tokens).
@@ -53,33 +78,60 @@ gradio-space-ci@git+https://huggingface.co/spaces/Wauplin/gradio-space-ci
 3. Go to your Space settings page.
 4. Add `HF_TOKEN` as a Space secret with your newly created token.
 
-(optional) You can also define a `SPACE_CI_SECRET` secret value that will be used to authenticate webhook calls. If you
-don't define one, a random secret value will be generated for you.
+(optional) You can also define a `SPACE_CI_SECRET` secret value that will be used to authenticate webhook calls. If you don't define one, a random secret value will be generated for you.
+
+### 3. Configure CI in `README.md`
 
+Edit the Space metadata in your `README.md` file:
 
-### 3. Configure CI in `app.py`
+```yaml
+title: ...
+sdk: gradio
+sdk_version: ...
+app_file: ...
+space_ci:
+   trusted_authors:
+      - Wauplin
+      # ^ Only PRs from trusted authors are deployed in an ephemeral Space.
+      # Space owners are automatically trusted.
+      # It is possible to manually trust other authors by adding them as a list.
+   private: auto
+      # ^ Can be 'true', 'false' or 'auto'. If 'auto', the ephemeral Spaces will have same
+      # visibility as the main Space.
+   variables: auto
+      # ^ By default ('auto'), all variables from the main Space are copied to the ephemeral Space.
+      # Otherwise, you can define a key-value mapping with variables to set.
+      # Variables are injected as environment variable in the ephemeral Space and are public for anyone landing on the Space.
+   secrets:
+      - HF_TOKEN
+      # ^ A list of secrets that must be copied from the main Space to the ephemeral Spaces.
+      # Secrets are injected as environment variable in the ephemeral Space.
+      # Be careful with the 'trusted_authors' list when setting secrets. 
+   hardware: cpu-basic
+      # ^ Defines which hardware to assign to the ephemeral Space.
+      # Can be set to 'auto' to assign the same hardware as the main Space.
+      # Defaults to 'cpu-basic' (free).
+   storage: null
+      # ^ Defines which storage to assign to the ephemeral Space.
+      # Can be set to 'auto' to assign the same storage as the main Space.
+      # Defaults to no storage (free).
+```
 
-Import the `gradio_space_ci` package and update the last line of your `app.py` script, just before launching the Gradio app.
+### 4. Enable CI in `app.py`
+
+Call `enable_space_ci` in your `app.py` file:
 
 ```py
 # app.py
 import gradio as gr
-from gradio_space_ci import configure_space_ci
+from gradio_space_ci import enable_space_ci
+
+enable_space_ci()
 
 # ANY gradio app
 with gr.Blocks() as demo:
     ...
-
-# Replace `demo.launch()` by `configure_space_ci(demo).launch()`.
-configure_space_ci(
-    demo,
-    trusted_authors=[],  # space owners + manually trusted authors
-    private="auto",  # ephemeral spaces will have same visibility as the main space. Otherwise, set to `True` or `False` explicitly.
-    variables="auto",  # same variables as the main space. Otherwise, set to a `Dict[str, str]`.
-    secrets=["HF_TOKEN"],  # which secret do I want to copy from the main space? Can be a `List[str]`.
-    hardware=None,  # "cpu-basic" by default. Otherwise set to "auto" to have same hardware as the main space or any valid string value.
-    storage=None,  # no storage by default. Otherwise set to "auto" to have same storage as the main space or any valid string value.
-).launch()
+demo.launch()
 ```
 
 And you're done! Ephemeral Spaces will be launched for each and every PR on your repo.
@@ -89,4 +141,5 @@ And you're done! Ephemeral Spaces will be launched for each and every PR on your
 
 - **Demo:** https://huggingface.co/spaces/Wauplin/gradio-space-ci
 - **README:** https://huggingface.co/spaces/Wauplin/gradio-space-ci/blob/main/README.md
-- **Questions and feedback:** https://huggingface.co/spaces/Wauplin/gradio-space-ci/discussions
+- **Questions and feedback:** https://huggingface.co/spaces/Wauplin/gradio-space-ci/discussions
+- **Release notes:** https://huggingface.co/spaces/Wauplin/gradio-space-ci/blob/main/RELEASE.md

app.py

@@ -2,18 +2,11 @@
 from pathlib import Path
 
 import gradio as gr
-from gradio_space_ci import configure_space_ci
+from gradio_space_ci import enable_space_ci
+
+enable_space_ci()
 
 with gr.Blocks() as demo:
     gr.Markdown(Path("README.md").read_text().split("---")[-1])
 
-if __name__ == "__main__":
-    configure_space_ci(
-        blocks=demo,  # ANY gradio app
-        trusted_authors=["clefourrier"],  # space owners + manually trusted authors
-        private="auto",  # ephemeral spaces will have same visibility as the main space. Otherwise, set to `True` or `False` explicitly.
-        variables="auto",  # same variables as the main space. Otherwise, set to a `Dict[str, str]`.
-        secrets=["HF_TOKEN"],  # which secret do I want to copy from the main space? Can be a `List[str]`.
-        hardware=None,  # "cpu-basic" by default. Otherwise set to "auto" to have same hardware as the main space or any valid string value.
-        storage=None,  # no storage by default. Otherwise set to "auto" to have same storage as the main space or any valid string value.
-    ).launch()
+demo.launch()

src/gradio_space_ci/__init__.py

@@ -20,21 +20,22 @@ The goal is to foster community contributions by making the review process as le
 - Demo: https://huggingface.co/spaces/Wauplin/gradio-space-ci
 - README: https://huggingface.co/spaces/Wauplin/gradio-space-ci/blob/main/README.md
 - Questions and feedback: https://huggingface.co/spaces/Wauplin/gradio-space-ci/discussions
+- Release notes: https://huggingface.co/spaces/Wauplin/gradio-space-ci/blob/main/RELEASE.md
 """
 import warnings
 
-from huggingface_hub import HfFolder
+from huggingface_hub import get_token
 
 # Check if `HF_TOKEN` is set. If not, Space CI will be disabled but no error is raised.
-if HfFolder.get_token() is None:
+if get_token() is None:
     warnings.warn(
         "Cannot find `HF_TOKEN` in environment variables. Please set a token in your Space secrets to enable ephemeral Spaces."
     )
 
-    def configure_space_ci(blocks, *args, kwargs):
-        return blocks
+    def enable_space_ci() -> None:
+        return
 else:
-    from .webhook import configure_space_ci  # noqa: F401
+    from .webhook import enable_space_ci  # noqa: F401
 
 
-__version__ = "0.1.2"
+__version__ = "0.1.3"

src/gradio_space_ci/webhook.py

@@ -2,6 +2,7 @@ import os
 import uuid
 import warnings
 from concurrent.futures import ThreadPoolExecutor
+from functools import wraps
 from pathlib import Path
 from typing import Any, Dict, List, Literal, Optional, TypedDict, Union
 
@@ -54,6 +55,50 @@ if SPACE_ID is not None:  # If running in a Space (i.e. not locally)
 EPHEMERAL_SPACES_CONFIG: Dict[str, Any] = {}
 
 
+def enable_space_ci() -> None:
+    """Enable Space CI for the current Space based on config from the README.md file.
+
+    Example:
+    ```py
+    import gradio as gr
+    from gradio_space_ci import enable_space_ci
+
+    enable_space_ci()
+
+    with gr.Blocks() as demo:
+        ...
+
+    demo.launch()
+    ```
+    """
+    if SPACE_ID is None:
+        print("Not in a Space: Space CI disabled.")
+        return
+
+    if IS_EPHEMERAL_SPACE:
+        print("In an ephemeral Space: Space CI disabled.")
+        return
+
+    card = RepoCard.load(repo_id_or_path=SPACE_ID, repo_type="space")
+    config = card.data.get("space_ci", {})
+    print(f"Enabling Space CI with config from README: {config}")
+
+    @wraps(gr.Blocks.launch)
+    def _launch(self: gr.Blocks, *args, **kwargs) -> None:
+        configure_space_ci(
+            blocks=self,
+            trusted_authors=config.get("trusted_authors"),
+            private=config.get("private", "auto"),
+            variables=config.get("variables", "auto"),
+            secrets=config.get("secrets"),
+            hardware=config.get("hardware"),
+            storage=config.get("storage"),
+        ).launch(*args, *kwargs)
+
+    # Monkey patch gradio
+    gr.Blocks.launch = _launch
+
+
 def configure_space_ci(
     blocks: Optional["gr.Blocks"] = None,
     trusted_authors: Optional[List[str]] = None,