Installation¶
Two things go into your app:
- the Python package,
pyios-firebase(pure Python, withrubicon-objc); - the Firebase iOS SDK packages of the products you use, linked into the Xcode build like in any native app.
1. The Python package¶
Add it to your app's requirements so the iOS build includes it:
2. The Firebase packages¶
Add firebase-ios-sdk with Swift Package Manager, and choose the products you use:
| Module | Swift package product | Also needs |
|---|---|---|
core |
FirebaseCore (comes with every product) |
GoogleService-Info.plist |
firestore |
FirebaseFirestore |
|
auth |
FirebaseAuth |
GoogleSignIn for auth.google, FacebookLogin for auth.facebook; URL schemes (Authentication) |
database |
FirebaseDatabase |
|
functions |
FirebaseFunctions |
|
storage |
FirebaseStorage |
|
remote_config |
FirebaseRemoteConfig |
|
app_check |
FirebaseAppCheck |
The App Attest capability for App Attest |
analytics |
FirebaseAnalytics |
|
crashlytics |
FirebaseCrashlytics |
The dSYM upload run script |
messaging |
FirebaseMessaging |
The Push Notifications capability, an APNs key in the console |
performance |
FirebasePerformance |
|
in_app_messaging |
FirebaseInAppMessaging-Beta |
FirebaseAnalytics, for Analytics event triggers and statistics |
The app must also link with -ObjC (OTHER_LDFLAGS): the Firebase
packages are static libraries, and without the flag the linker drops the
Objective-C classes that nothing in the native code refers to by name. Python
finds those classes at runtime, so it needs all of them.
kivyforge adds the packages
and the settings from pyproject.toml:
[[tool.kivy.ios.include_files]]
dest = "."
sources = ["GoogleService-Info.plist"]
[tool.kivy.ios.native.swift_packages.Firebase]
url = "https://github.com/firebase/firebase-ios-sdk.git"
requirement = { from = "13.1.1" }
products = [
"FirebaseAuth",
"FirebaseFirestore",
"FirebaseStorage",
]
[tool.kivy.ios.xcode.build_settings]
OTHER_LDFLAGS = "$(inherited) -ObjC"
This is how the library's own end-to-end test app is built
(e2e/ios/pyproject.toml).
- Create the Xcode project:
toolchain create MyApp ~/code/myapp. - Open
myapp-ios/myapp.xcodeprojin Xcode. - File > Add Package Dependencies..., enter
https://github.com/firebase/firebase-ios-sdk.git, and pick the products you use. - In the target's Build Settings, add
-ObjCto Other Linker Flags. - Drag
GoogleService-Info.plistinto the project (target membership: your app).
- Generate the Xcode project:
briefcase create iOS. - Open the project under
build/<app>/ios/xcode/in Xcode. - File > Add Package Dependencies..., enter
https://github.com/firebase/firebase-ios-sdk.git, and pick the products you use. - In the target's Build Settings, add
-ObjCto Other Linker Flags. - Add
GoogleService-Info.plistto the app target.
Warning
briefcase create makes the Xcode project again from its template:
changes made in Xcode are lost. Run it once, then use
briefcase update and briefcase build.
A class is missing?
NameError: ... FIRFirestore (or another FIR... class) when you call a
product means its package is not in the build, or -ObjC is missing.
Importing a module never fails for this: classes are looked up the first
time they are used.
Every product page has an App configuration section with exactly what it needs, and App configuration puts every product together.
Package layout¶
pyios_firebase/
├── core/ configure(), default_app()
├── types.py FirebaseError, callback types, QueryDict
├── util.py value and error conversion, block keep-alive
├── firestore/ Firestore, references, snapshots, queries, FieldValue, Filter...
├── auth/ Auth, User, credentials and providers, AuthError
│ ├── google.py Google Sign-In
│ ├── apple.py Sign in with Apple
│ ├── facebook.py Facebook Login
│ └── multi_factor.py SMS and TOTP second factors
├── database/ Database, DatabaseReference, DatabaseQuery, DataSnapshot...
├── functions/ Functions, HTTPSCallable, FunctionsError
├── in_app_messaging/ InAppMessaging, the message classes, DisplayDelegate
├── storage/ Storage, StorageReference, StorageMetadata, tasks
├── remote_config/ RemoteConfig, RemoteConfigValue, ConfigUpdate
├── app_check/ providers, AppCheck, AppCheckToken, AppCheckProvider
├── analytics/ Analytics, Event, Param, UserProperty, consent
├── crashlytics/ Crashlytics, ExceptionModel, StackFrame, CrashlyticsReport
├── messaging/ Messaging, MessagingError
│ └── notifications.py permission, handlers, Notification
└── performance/ Performance, Trace, HTTPMetric
Import from the product's subpackage:
from pyios_firebase import core
from pyios_firebase.auth import Auth
from pyios_firebase.firestore import FieldValue, Filter, Firestore
Next step¶
Set up Firebase in your app.