Skip to content
Google Cloud Firestore modern and simplest convenient ORM package in Python. FireO is specifically designed for the Google's Firestore
Python
Branch: master
Clone or download
Latest commit 9089d94 Nov 10, 2019

README.md

PyPI version Build Status

FireO Logo

A modern and simplest convenient ORM package in Python. FireO is specifically designed for the Google's Firestore, it's more than just ORM. It implements validation, type checking, relational model logic and much more facilities.

Get Started!




Installation

pip install fireo

Example Usage

from fireo.models import Model
from fireo.fields import TextField

class User(Model):
    name = TextField()


u = User()
u.name = "Azeem Haider"
u.save()

# Get user
user = User.collection.get(u.key)
print(user.name)

Documentation

Full documentation is available in the FireO Doc.

Contributing

Bug reports and pull requests are welcome. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

  1. Check FireO Project TODO list or newcomers contribute
  2. Checkout Feature branch
  3. Write tests for your functionality
  4. Mention in Documentation, what you has done and how other can use it

License

This is official FireO Repository. Powered by OctaByte Licensed under Apache License 2.0

You can’t perform that action at this time.