Firebase Management Scipts (avinashkranjan#935)

Author: shantamsultania

FirebaseScripts/CredentialsHelper.py

@@ -0,0 +1,53 @@
+import os
+
+from dotenv import load_dotenv
+
+dotenv_path = "./credentials.env"
+load_dotenv(dotenv_path)
+
+firebaseConfig = {
+    "apiKey": "",
+    "authDomain": "",
+    "databaseURL": "",
+    "projectId": "",
+    "storageBucket": "",
+    "messagingSenderId": "",
+    "appId": "",
+    "measurementId": ""
+}
+
+
+def get_fireBase_credentials():
+    try:
+
+        # Accessing variables.
+
+        apiKey = os.getenv('apiKey')
+        authDomain = os.getenv('authDomain')
+        databaseURL = os.getenv('databaseURL')
+        projectId = os.getenv('projectId')
+        storageBucket = os.getenv('storageBucket')
+        messagingSenderId = os.getenv('messagingSenderId')
+        appId = os.getenv('appId')
+        measurementId = os.getenv('measurementId')
+        credentials = [apiKey, authDomain, databaseURL, projectId, storageBucket, messagingSenderId, appId,
+                       measurementId]
+        if any(not(credential) for credential in credentials):
+            raise ValueError("Value cannot be None ")
+        else:
+            firebaseConfig["apiKey"] = apiKey
+            firebaseConfig["authDomain"] = authDomain
+            firebaseConfig["databaseURL"] = databaseURL
+            firebaseConfig["projectId"] = projectId
+            firebaseConfig["storageBucket"] = storageBucket
+            firebaseConfig["messagingSenderId"] = messagingSenderId
+            firebaseConfig["appId"] = appId
+            firebaseConfig["measurementId"] = measurementId
+
+    except:
+        print("error while getting the Keys ")
+        raise
+
+    return firebaseConfig
+
+get_fireBase_credentials()

FirebaseScripts/Readme.md

@@ -0,0 +1,66 @@
+## Script for Firebase Management for beginners
+
+This python script can be used to access or manage different features of firebase database by google.
+
+This provides features like :
+
+### Authentication
+
+1. Create new User
+2. Sign In Used based on email or password
+3. Authorize a new uer 
+4. email verification
+5. reset password 
+
+### Database :
+
+1. Create your Real Time Database 
+2. Retrieve Data from the Database
+3. update Data 
+4. Delete Data 
+
+Note : 
+
+Firebase Real time database is an Non SQL based Database.
+
+### Storage : 
+
+1. Retrieve Data 
+2. Send data 
+3. Download Data 
+4. Update / Delete Data 
+
+Note :
+
+firebase Storage is used to store all the files/ non text based data in the Database.
+
+## Installation
+
+First of all install [python]("https://www.python.org/downloads/") on your system.
+```
+pip install pyrebase4
+pip install firebase
+```
+## Steps to Get your Firebase Credentials 
+
+1. Go to [FireBase Console]("https://console.firebase.google.com/") 
+2. Sign in / Login with your Google Account or any other Account you prefer
+3. after that in your window the option to create a new Project will be there go and create a new project 
+4. after that fill in the basic details like project name, etc 
+5. after that just go and click on add an App icon on the screen 
+6. in that select web app as the option 
+7. after that you will see some credentials that have been allocated by the Firebase Cloud service 
+8. just copy-paste them accordingly in credentials.env and Do
+
+## Learn more 
+
+Learn more about firebase and its services [firebase]("https://firebase.google.com/") 
+
+Learn more about pyrebase a wrapper framwork for firebase API's [pyrebase]("https://openbase.com/python/Pyrebase")
+
+### Made with ❤️ by Shantam Sultania
+
+You can find me at:-
+[Linkedin](https://www.linkedin.com/in/shantam-sultania-737084175/) or [Github](https://github.com/shantamsultania) .
+
+Happy coding ❤️ .

FirebaseScripts/credentials.env

@@ -0,0 +1,9 @@
+
+apiKey = ""
+authDomain =  ""
+databaseURL = ""
+projectId =  ""
+storageBucket = ""
+messagingSenderId = ""
+appId =  ""
+measurementId = ""

FirebaseScripts/firebase_authentications.py

@@ -0,0 +1,53 @@
+import pyrebase
+
+import FirebaseScripts.CredentialsHelper as credentials
+
+firebase = pyrebase.initialize_app(credentials.get_fireBase_credentials())
+
+auth = firebase.auth()
+
+
+def create_user_with_token():
+    token = auth.create_custom_token("enter the token here ")
+    print(token)
+    return token
+
+
+def create_user_with_email(email, password):
+    user = auth.create_user_with_email_and_password(email, password)
+    print(user)
+    return user
+
+
+def sign_in_user_with_email(email, password):
+    user = auth.sign_in_with_email_and_password(email=email, password=password)
+    print(user)
+    return user
+
+
+def signIn_user_with_token(token):
+    user = auth.sign_in_with_custom_token(token)
+    print(user)
+    return user
+
+
+def email_verifications(user):
+    verification = auth.send_email_verification(user["idToken"])
+    print(verification)
+    return verification
+
+
+def password_reset(email):
+    password_rest = auth.send_password_reset_email(email)
+    print(password_rest)
+    return password_rest
+
+
+def get_user_account_info(user):
+    info = auth.get_account_info(user["idToken"])
+    print(info)
+    return info
+
+
+if __name__ == "__main__":
+    create_user_with_email("email here ", "password here ")

FirebaseScripts/firebase_database.py

@@ -0,0 +1,55 @@
+import pyrebase
+
+import FirebaseScripts.CredentialsHelper as credentials
+
+firebase = pyrebase.initialize_app(credentials.get_fireBase_credentials())
+
+database = firebase.database()
+
+
+def create_data_path():
+    response = database.child("testdata")
+    print(response)
+    return response
+
+
+def add_data(data):
+    response = database.child("testdata").push(data)
+    print(response)
+    return response
+
+
+def set_key_of_data(data):
+    response = database.child("testdata").child("newKey").set(data)
+    print(response)
+    return response
+
+
+def update_data(updateData):
+    response = database.child("testdata").child("newKey").update(updateData)
+    print(response)
+    return response
+
+
+def delete_data(key):
+    response = database.child("testdata").child(key).remove()
+    print(response)
+    return response
+
+
+def retrieve_data():
+    response = database.child("testdata").get()
+    print("data " + str(response))
+    print("Keys : " + str(response.key()))
+    print("Values : " + str(response.val()))
+    return response
+
+
+def print_all_data():
+    for i in retrieve_data().each():
+        print(i.key())
+        print(i.val())
+
+
+if __name__ == "__main__":
+    print_all_data()

FirebaseScripts/firebase_storage.py

@@ -0,0 +1,29 @@
+import pyrebase
+
+import FirebaseScripts.CredentialsHelper as credentials
+
+firebase = pyrebase.initialize_app(credentials.get_fireBase_credentials())
+
+storage = firebase.storage()
+
+
+def send_file(firebase_path, source_path):
+    response = storage.child(firebase_path).put(source_path)
+    print(response)
+    return response
+
+
+def delete_file(firebase_path, name_of_file_to_delete):
+    response = storage.child(firebase_path).delete(name_of_file_to_delete)
+    print(response)
+    return response
+
+
+def download_file(firebase_path, file_name):
+    response = storage.child(firebase_path).download(path="./", filename=file_name)
+    print(response)
+    return response
+
+
+if __name__ == "__main__":
+    download_file("enter your path here ", "enter your file name here ")

FirebaseScripts/requirements.txt

@@ -0,0 +1,2 @@
+pyrebase4==4.4.3
+firebase=3.0.1