https://github.com/davidk20/firebase-scripts
Utility scripts to quickly interact with and update Firestore databases
https://github.com/davidk20/firebase-scripts
firebase firebase-firestore json python utility
Last synced: 2 months ago
JSON representation
Utility scripts to quickly interact with and update Firestore databases
- Host: GitHub
- URL: https://github.com/davidk20/firebase-scripts
- Owner: Davidk20
- Created: 2024-04-25T20:15:05.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-09-16T15:47:23.000Z (almost 2 years ago)
- Last Synced: 2025-07-05T07:17:35.878Z (about 1 year ago)
- Topics: firebase, firebase-firestore, json, python, utility
- Language: Python
- Homepage:
- Size: 15.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
firebase-scripts
A set of utility scripts to quickly interact with Firebase Firestore databases.
## Key Features
- Validate JSON files
- Convert CSV files to JSON objects
- Upload JSON files as docs to Firebase
## Setup
### Configure Environment
```bash
python3 -m venv venv
# MacOS / Linux
source venv/bin/activate
# CMD
venv/Scripts/activate.bat
# Powershell
venv/Scripts/Activate.ps1
# Install requirements
pip install -r requirements.txt
```
#### [Firebase Emulator][firebase-emulator]
It is possible for this script to be used with Firebase Emulator so that test environments can be setup or the data can be validated before uploading to Firebase.
To configure Firebase Emulator:
```bash
# Initialise Firebase Emulators
firebase init emulators
# Start Emulator
firebase emulators:start
# OPTIONAL - run the emulator whilst saving state
firebase emulators:start --import .env --export-on-exit .env
```
To configure the script for working with the Firebase Emulator, create a `.env` file at the root of the project and add the following line:
```bash
export FIRESTORE_EMULATOR_HOST="127.0.0.1:8080"
```
Where the IP address corresponds to the one configured in the emulator.
## Usage
```
❯ python3 main.py
usage: main.py [-h] [-d] [-f FILE] [-k KEY] [-e] [-c COLLECTION] {validate,upload}
A set of utility scripts to quickly interact with Firebase Firestore databases.
positional arguments:
{validate,upload} validate = Validate the JSON, upload = Write the JSON to firestore,
options:
-h, --help show this help message and exit
-d, --duplicate Allow duplicate entries
-f FILE, --file FILE The file path to the JSON data.
-k KEY, --key KEY Path to the Firebase Service Key.
-c COLLECTION, --collection COLLECTION
The collection to upload the data to.
Upload Options:
-e, --emulator Use Firebase Emulator
```
[firebase-emulator]: https://firebase.google.com/docs/emulator-suite