FirebaseConfig - chad63e/anvil-firebase GitHub Wiki

FirebaseConfig

Table of Contents

Class Description

The FirebaseConfig class serves as a configuration container for integrating Firebase into Python applications. It manages Firebase-specific settings such as API key, authentication domain, project ID, and others, ensuring correct format and validity.

Constructor

__init__(self, api_key, auth_domain, project_id, storage_bucket, messaging_sender_id, app_id, measurement_id)

Initializes a new instance of the FirebaseConfig class, establishing the necessary configuration for a Firebase project.

Parameters:

  • api_key (str): The API key for your Firebase project.
  • auth_domain (str): The domain for your Firebase authentication.
  • project_id (str): The ID for your Firebase project.
  • storage_bucket (str): The name of your Firebase storage bucket.
  • messaging_sender_id (str): The sender ID for Firebase messaging.
  • app_id (str): The ID for your Firebase app.
  • measurement_id (str): The ID for Firebase analytics.

Public Methods

to_dict(self) -> dict

Converts the Firebase configuration to a dictionary, facilitating its use with Firebase APIs.

Returns:

  • dict: A dictionary of all configuration parameters.

from_dict(cls, d: dict) -> "FirebaseConfig"

Creates a FirebaseConfig instance from a dictionary, useful for initializing the configuration from structured data.

Parameters:

  • d (dict): Dictionary containing Firebase configuration keys and values.

Returns:

  • FirebaseConfig: An instance of FirebaseConfig.

Obtaining Firebase Config Details

To obtain Firebase configuration details, follow these steps:

  1. Create or Open your Firebase Project:

    • Visit the Firebase Console.
    • Sign in with your Google account.
    • Create a new project or open an existing one.

  2. Go to Project Settings:

    • Click the gear icon next to "Project Overview" in the sidebar.
    • Select "Project settings".

  3. Locate Your Config Object:

    • In the "Your apps" section, select the web app or add a new app if needed.
    • Find your Firebase configuration in the 'Firebase SDK snippet' section.
    • Choose "Config" to get the configuration object.

  4. Copy the Config Object:

    • The configuration object contains all the necessary details: apiKey, authDomain, projectId, storageBucket, messagingSenderId, appId, and measurementId.
    • Copy these values to use in your application.

Code Examples

Example 1: Creating a FirebaseConfig Instance

from Firebase.client import FirebaseConfig


firebase_config = FirebaseConfig(
    api_key="your_api_key",
    auth_domain="your_auth_domain",
    project_id="your_project_id",
    storage_bucket="your_storage_bucket",
    messaging_sender_id="your_messaging_sender_id",
    app_id="your_app_id",
    measurement_id="your_measurement_id"
)

Example 2: Converting FirebaseConfig to Dictionary

config_dict = firebase_config.to_dict()

Example 3: Initializing FirebaseConfig from Dictionary

from Firebase.client import FirebaseConfig


config_dict = {
    "apiKey": "your_api_key",
    "authDomain": "your_auth_domain",
    "projectId": "your_project_id",
    "storageBucket": "your_storage_bucket",
    "messagingSenderId": "your_messaging_sender_id",
    "appId": "your_app_id",
    "measurementId": "your_measurement_id"
}
firebase_config = FirebaseConfig.from_dict(config_dict)

In these examples, the FirebaseConfig class is used for managing Firebase configuration in a structured and validated manner. This method simplifies the process of configuring Firebase services within an application. The steps provided guide you through obtaining the necessary configuration details from the Firebase Console.