Empyrebase is a straightforward Python wrapper designed for the Firebase API. This library streamlines the integration of Firebase's services into Python applications, enabling developers to harness the power of Firebase for user authentication, database management, file storage, and more.

Getting Started with Empyrebase

Compatibility

Empyrebase is compatible with Python 3 and is not designed to function with Python 2.

Configuration

To incorporate Empyrebase into an application, initialize it with your Firebase project credentials:

import empyrebase

config = {
    "apiKey": "apiKey",
    "authDomain": "projectId.firebaseapp.com",
    "databaseURL": "https://databaseName.firebaseio.com",
    "storageBucket": "projectId.appspot.com"
}

firebase = empyrebase.initialize_app(config)

For enhanced functionality, a service account credential can be included:

config = {
    "apiKey": "apiKey",
    "authDomain": "projectId.firebaseapp.com",
    "databaseURL": "https://databaseName.firebaseio.com",
    "storageBucket": "projectId.appspot.com",
    "serviceAccount": "path/to/serviceAccountCredentials.json"
}

Utilizing Firebase Services

Once initialized, Empyrebase allows seamless access to various Firebase services:

• Authentication: Manage user authentication easily with methods like sign_in_with_email_and_password(), sign_in_anonymous(), and update_profile().
• Database: Operate with real-time databases using methods like push(), set(), update(), and remove(). For instance:

  db = firebase.database()
  data = {"name": "Mortimer 'Morty' Smith"}
  results = db.child("users").push(data, user['idToken'])
  

• Storage: Upload and retrieve files with the Storage service utilizing methods such as put(), download(), and get_url(). Example:

  storage.child("images/example.jpg").put("example2.jpg")
  

• Firestore: Interact with Firestore collections for advanced document management. Create, retrieve, update, and delete documents easily with methods like:

  firestore.create_document("users/user_id", {"name": "John Doe"})
  

Advanced Features

Empyrebase also supports token management, user account operations (including email verification and password resets), and complex queries to facilitate nuanced data interactions. For example, to retrieve users ordered by score:

users_by_score = db.child("users").order_by_child("score").get()

For those looking to leverage Firebase services through Python, Empyrebase provides an intuitive and efficient toolkit, significantly simplifying the integration process.