Metadata-Version: 2.1
Name: firestore-model
Version: 0.0.3
Summary: A wrapper for creating model classes using Google's Cloud Firestore schemaless database
Home-page: https://gitlab.com/futureprojects/firestore-model
Author: Future Projects
Author-email: info@futureprojects.io
License: UNKNOWN
Description: # firestore-model
        
        Quickly and simply create model classes for Google's Cloud Firestore schemaless database. 
        
        
        ## Overview
        This project seeks to provide a similar convenience and utility for using Cloud Firestore with the newly available Python 3.7 App Engine Envinronment as the NDB client library does for using Cloud Datastore with Python 2.7 App Engine.
        
        ## Example
        
        ```
        import firestore_model
        from google.firestore import firestore
        from filestore_model import Model, Query
        
        # initialize the database connection globally for Firestore Model 
        firestore_model.db = firestore.Client()
        
        # Define a data structure for a User
        @dataclass
        class User(Model):
          first_name:str
          last_name:str
          occupation:str
        
        # Create a new user, pass save = True to automagically save the model object
        u1 = User.make(
            first_name='Sonic',
            last_name='Brown',
            occupation='circus dog'
            save=True
          )
        
        # Fetch all users that match a given query
        users = User.query([
            ('occupation', 'circus dog'), 
            ('created', '>', 1540776978)
          ]
        ).get()
        
        # Iterate through the results of the query
        for u in users:
          print(u.id, u.created, u.first_name, u.last_name, u.occupation)
        ```
        
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3.7
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
