[#23] Set GCP credentials (#24)

* [#23] Set GCP credentials

To deploy the app to Hugging Face Spaces, we need to set the GCP credentials.

* document

---------

Co-authored-by: suhyun.kang <suhyun.kang@yanolja.group>

.gitignore

@@ -1,3 +1,4 @@
 venv
 *.log
 __pycache__
+credentials.json

README.md

@@ -19,9 +19,22 @@
    Set your OpenAI API key as an environment variable and start the application:
 
    ```shell
-   OPENAI_API_KEY=<your key> python3 app.py
+   GOOGLE_CLOUD_PROJECT=<your project id> CREDENTIALS_PATH=<your crednetials path> OPENAI_API_KEY=<your key> python3 app.py
    ```
 
-   Replace `<your key>` with your GCP project ID.
+   Replace `<your project id>`, `<your crednetials path>`, and `<your key>` with your GCP project ID, the path to your GCP credentials file, and your OpenAI API key respectively.
 
    > To run the app with [auto-reloading](https://www.gradio.app/guides/developing-faster-with-reload-mode), use `gradio app.py --demo-name app` instead of `python3 app.py`.
+
+## Handling GCP credentials for development and deployment
+
+### Local environment
+
+1. Store your credentials in a file on your local machine.
+1. Set the `CREDENTIALS_PATH` environment variable to point to this file.
+1. The application will read the credentials from this file when running locally.
+
+### Deployment environment
+
+1. Set the `CREDENTIALS` environment variable in your deployment platform's settings to your credentials JSON string.
+2. The application will parse and use these credentials when deployed.

app.py

@@ -1,11 +1,13 @@
 """
 It provides a platform for comparing the responses of two LLMs. 
 """
-
 import enum
+import json
+import os
 from uuid import uuid4
 
 import firebase_admin
+from firebase_admin import credentials
 from firebase_admin import firestore
 import gradio as gr
 
@@ -13,8 +15,26 @@ from leaderboard import build_leaderboard
 import response
 from response import get_responses
 
+# Path to local credentials file, used in local development.
+CREDENTIALS_PATH = os.environ.get("CREDENTIALS_PATH")
+
+# Credentials passed as an environment variable, used in deployment.
+CREDENTIALS = os.environ.get("CREDENTIALS")
+
+
+def get_credentials():
+  # Set credentials using a file in a local environment, if available.
+  if CREDENTIALS_PATH and os.path.exists(CREDENTIALS_PATH):
+    return credentials.Certificate(CREDENTIALS_PATH)
+
+  # Use environment variable for credentials when the file is not found,
+  # as credentials should not be public.
+  json_cred = json.loads(CREDENTIALS)
+  return credentials.Certificate(json_cred)
+
+
 # TODO(#21): Fix auto-reload issue related to the initialization of Firebase.
-db_app = firebase_admin.initialize_app()
+firebase_admin.initialize_app(get_credentials())
 db = firestore.client()
 
 SUPPORTED_TRANSLATION_LANGUAGES = [

requirements.txt

@@ -27,14 +27,18 @@ google-api-core==2.16.2
 google-api-python-client==2.116.0
 google-auth==2.27.0
 google-auth-httplib2==0.2.0
+google-cloud-aiplatform==1.40.0
+google-cloud-bigquery==3.17.1
 google-cloud-core==2.4.1
 google-cloud-firestore==2.14.0
+google-cloud-resource-manager==1.12.0
 google-cloud-storage==2.14.0
 google-crc32c==1.5.0
 google-resumable-media==2.7.0
 googleapis-common-protos==1.62.0
 gradio==4.16.0
 gradio_client==0.8.1
+grpc-google-iam-v1==0.13.0
 grpcio==1.60.1
 grpcio-status==1.60.1
 h11==0.14.0
@@ -86,6 +90,7 @@ rpds-py==0.17.1
 rsa==4.9
 ruff==0.2.0
 semantic-version==2.10.0
+shapely==2.0.2
 shellingham==1.5.4
 six==1.16.0
 sniffio==1.3.0