No project description provided
Project description
MagicDB
A fully typed Firestore ORM for python -- the easiest way to store data.
MagicDB inherets from Pydantic, so you get all the power of Pydantic models with the functionality of Firestore: https://pydantic-docs.helpmanual.io/.
Instalation
pip install magicdb
Initialize the DB
MagicDB is initialized via a Firestore service account json which you download from your Firebase console.
Once you have the json, you must tell MagicDB where it is, either by 1) setting the GOOGLE_APPLICATION_CREDENTIALS
environment variable to the json path, or by 2) calling magicdb.connect with the path:
# 1)
# You can set the env variable from the terminal too: export GOOGLE_APPLICATION_CREDENTIALS="path/to/my-service-account.json"
import os
os.environ["GOOGLE_APPLICATION_CREDENTIALS"] = "path/to/my-service-account.json"
# OR
# 2)
import magicdb
magicdb.connect(from_file="path/to/my-service-account.json")
Example
from magicdb.Models import MagicModel
class Salesman(MagicModel):
name: str = None
company: str = None
s = Salesman()
s.name = 'Jim'
s.save()
# Get Salesman
s = Salesman.collection.get(s.id)
print(s.name) # Jim
Fields
Use any type mypy will accept!
Fields Example
from datetime import datetime
class Manager(MagicModel):
name: str
age: int
company: str = 'Dunder Mifflin'
startedWorkingAt: datetime = None
# m = Manager(name='Michael Scott', age=44) # you must pass in the required fields on initializing the object.
m.age = 45
m.save() # Success! New doc in collection "manager" as: { name: Michael Scott, age: 45, company: Dunder Mifflin }
m = Manager(name='Dwight Schrute') # Exception since age is required but not given
You can also add other Objects as a field.
NestedModel Example
class Dog(MagicModel):
age: int
owner: Manager
dog = Dog()
dog.age = 3
dog.owner = Manager(name='Robert California', age=59)
dog.save()
print(dog)
Collections
The collection name for a class defaults to the class' name in lowercase. To set the collection name, use the Meta
class.
Meta Example
class Student(MagicModel):
name: str = None
school: str = 'UPenn'
class Meta:
collection_name = 'students'
s = Student(name='Amy Gutman')
s.save() # creates a new document in the "students" collection
print(s) # name='Amy Gutman' school='UPenn'
You can also inheret classes.
Inheritance Example
class ExchangeStudent(Student):
originalCountry: str
class Meta:
collection_name = 'exchangeStudents'
e = ExchangeStudent(originalCountry='UK')
print(e.school) # UPenn
e.save()
print(e) # name=None school='UPenn' originalCountry='UK'
Queries
You can make queries with the same syntax you would using the Python firebase-admin SDK. But FireORM returns the objects.
Queries Example
e = ExchangeStudent(originalCountry='UK')
print(e.school) # UPenn
e.save()
print(e) # name=None school='UPenn' originalCountry='UK'
managers = Manager.collection.where('name', '==', 'Michael Scott').limit(1).stream()
print(managers) # [Manager(name='Michael Scott', age=45, company='Dunder Mifflin', startedWorkingAt=None)]
print(managers[0].id)
manager = Manager.collection.get('0mIWZ8FfgQzBanCllqsV')
print(manager) # name='Michael Scott' age=45 company='Dunder Mifflin' startedWorkingAt=None
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file magicdb-0.2.189.tar.gz
.
File metadata
- Download URL: magicdb-0.2.189.tar.gz
- Upload date:
- Size: 29.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.0.10 CPython/3.8.7 Darwin/20.3.0
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | aea3a52ebc3929e2fdbba3452681c9c686832c21459e7b8df5d993afce488076 |
|
MD5 | 8a14ea0c2451694983146f587f1cc401 |
|
BLAKE2b-256 | 4a03046e84279d0c26bfd3cc16ab05b375c043349807defb1e3dc80a28016b29 |
File details
Details for the file magicdb-0.2.189-py3-none-any.whl
.
File metadata
- Download URL: magicdb-0.2.189-py3-none-any.whl
- Upload date:
- Size: 43.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.0.10 CPython/3.8.7 Darwin/20.3.0
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | c40ffe91143900fd0f1294991fe88283baf936b5ee24f90fa40ceebbc557b7e4 |
|
MD5 | e7bfb9463c7215ca76d873f3f8fdb2db |
|
BLAKE2b-256 | 6073b34c697e9ac5188eb8042c8d61d9cc0a8d52c9970a95a0f7b8db0095041c |