Introduction¶
pyios-firebase lets a Python app on iOS use Firebase: Kivy, BeeWare, or any other framework where Rubicon-ObjC runs. You write Python; the library calls the official Firebase iOS SDK for you.
from datetime import UTC, datetime
from pyios_firebase import core
from pyios_firebase.auth import Auth
from pyios_firebase.firestore import Firestore
core.configure()
def on_signed_in(result, error):
if error is not None:
print("Sign-in failed:", error.name, error.description)
return
uid = result.user.uid
Firestore.firestore().document_with_path(f"users/{uid}").set_data(
{"last_seen": datetime.now(UTC)}, merge=True
)
Auth.auth().sign_in_anonymously(on_signed_in)
How it works¶
flowchart LR
A["Your Python code"] --> B["pyios_firebase"]
B -- "Rubicon-ObjC" --> C["Firebase iOS SDK"]
C --> D["Firebase servers<br/>or the local emulators"]
C -. "callbacks" .-> B
B -. "Python values,<br/>typed errors" .-> A
The Firebase iOS SDK is the one Swift and Objective-C apps use. Your app links it like any native app does; pyios-firebase finds its classes at runtime through Rubicon-ObjC. In between, the library:
- converts values both ways:
dict,list,datetime,bytes,Nonein, plain Python out (neverNSDictionaryorNSNumber); - keeps callback blocks alive until Firebase calls them: a Python function passed to Objective-C would otherwise be freed too early, and the app would crash when Firebase calls it;
- gives typed errors (
AuthError,StorageError...) with the error code as a name you can compare, instead of a rawNSError; - checks your input first where the SDK would abort the whole app (an
Objective-C exception cannot be caught from Python): a bad database path, a
value JSON cannot carry, a trace made before Firebase is configured... You get
a
ValueError,TypeErrororRuntimeErrorinstead.
No Objective-C, no Swift
There are no .m, .h or .swift files to add to your app. The only
native work is adding the Firebase packages to the Xcode build, once
(see Installation).
Products¶
| Product | Module | Firebase package | What you get |
|---|---|---|---|
| Cloud Firestore | firestore |
FirebaseFirestore |
Documents, queries, live listeners, transactions, aggregates |
| Authentication | auth |
FirebaseAuth |
Every iOS sign-in method, multi-factor, account management |
| Realtime Database | database |
FirebaseDatabase |
A live JSON tree, transactions, presence, offline |
| Cloud Functions | functions |
FirebaseFunctions |
HTTPS callable functions |
| Cloud Storage | storage |
FirebaseStorage |
Uploads, downloads, metadata, listing |
| Remote Config | remote_config |
FirebaseRemoteConfig |
Defaults, fetch, real-time updates, custom signals |
| App Check | app_check |
FirebaseAppCheck |
App Attest, DeviceCheck, debug and Python providers |
| Analytics | analytics |
FirebaseAnalytics |
Events, screen views, user properties, consent |
| Crashlytics | crashlytics |
FirebaseCrashlytics |
Crashes and Python exceptions as issues |
| Cloud Messaging | messaging |
FirebaseMessaging |
FCM tokens, topics, notifications |
| Performance Monitoring | performance |
FirebasePerformance |
Traces and HTTP metrics |
| In-App Messaging | in_app_messaging |
FirebaseInAppMessaging-Beta |
Messages in the app: listeners, events, your own display |
Every product is its own subpackage, and importing one never loads another: you only need the Firebase packages of the products you import.
Requirements¶
- An iOS app built with Python: Kivy (kivy-ios or kivyforge), BeeWare (Briefcase), or similar
- Python 3.11 or newer
rubicon-objc0.5.2 or newer (installed with pyios-firebase)- The Firebase iOS SDK packages of the products you use (version 13 or newer: the library is tested with 13.1.1)
- iOS 15 or newer, the Firebase SDK's minimum
- A Firebase project with an iOS app, and its
GoogleService-Info.plist
Tested on iOS¶
Every product runs end to end in the iOS Simulator, through the real Firebase SDK, against the Firebase Emulator Suite: about 80 tests on each change, including a real crash found again by Crashlytics on the next launch and a notification pushed to the Simulator. See Development and testing.
Next steps¶
- Install: add the library and the Firebase packages to your app.
- Set up: add
GoogleService-Info.plistand start Firebase. - Use the emulators: develop against a local Firebase.
- Callbacks and threads: how results come back to your code.