{"id":24388783,"url":"https://github.com/octabyte-io/fireo","last_synced_at":"2025-04-06T04:11:13.400Z","repository":{"id":37390731,"uuid":"211646730","full_name":"octabyte-io/FireO","owner":"octabyte-io","description":"Google Cloud Firestore modern and simplest convenient ORM package in Python. FireO is specifically designed for the Google's Firestore","archived":false,"fork":false,"pushed_at":"2024-08-17T05:02:19.000Z","size":683,"stargazers_count":255,"open_issues_count":22,"forks_count":32,"subscribers_count":13,"default_branch":"master","last_synced_at":"2025-03-06T13:07:53.167Z","etag":null,"topics":["firebase","fireo","firestore","firestore-models","google-cloud-firestore","orm","orm-model","python"],"latest_commit_sha":null,"homepage":"https://fireo.octabyte.io","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/octabyte-io.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":null,"custom":["bit.ly/FireO-Paypal"],"community_bridge":"fireo","open_collective":"fireo","patreon":"fireo","ko_fi":"fireo1","tidelift":null,"liberapay":null,"issuehunt":null,"otechie":null}},"created_at":"2019-09-29T10:37:00.000Z","updated_at":"2025-03-05T21:12:14.000Z","dependencies_parsed_at":"2023-11-11T22:04:31.367Z","dependency_job_id":"d6d4bbee-4979-4bb7-9303-877d7d530004","html_url":"https://github.com/octabyte-io/FireO","commit_stats":{"total_commits":448,"total_committers":16,"mean_commits":28.0,"dds":0.2879464285714286,"last_synced_commit":"69a12aca4438f417e8c1d93b835022774a3b8511"},"previous_names":["octabyte-io/fireo","octabytes/fireo"],"tags_count":57,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/octabyte-io%2FFireO","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/octabyte-io%2FFireO/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/octabyte-io%2FFireO/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/octabyte-io%2FFireO/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/octabyte-io","download_url":"https://codeload.github.com/octabyte-io/FireO/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247430870,"owners_count":20937874,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["firebase","fireo","firestore","firestore-models","google-cloud-firestore","orm","orm-model","python"],"created_at":"2025-01-19T14:29:39.726Z","updated_at":"2025-04-06T04:11:13.379Z","avatar_url":"https://github.com/octabyte-io.png","language":"Python","funding_links":["bit.ly/FireO-Paypal","https://funding.communitybridge.org/projects/fireo","https://opencollective.com/fireo","https://patreon.com/fireo","https://ko-fi.com/fireo1"],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"right\"\u003e\n\n![Build Status](https://github.com/octabytes/FireO/actions/workflows/python-package-testing.yml/badge.svg)\n\u003ca href=\"https://badge.fury.io/py/fireo\"\u003e\n\u003cimg src=\"https://badge.fury.io/py/fireo.svg\" alt=\"PyPI version\"\u003e\n\u003c/a\u003e\n\n\u003c/p\u003e\n\n\u003cp\u003e\n    \u003ch1 align=\"center\"\u003e\u003cimg src=\"fireo_logo.png\" height=\"100\" alt=\"FireO Logo\"\u003e\u003c/h1\u003e\n    \u003cp align=\"center\"\u003e\n        A modern and simplest convenient ORM package in Python.\n        FireO is specifically designed for the Google's Firestore, it's more than just ORM.\n        It implements validation, type checking, relational model logic and much more facilities.\n    \u003c/p\u003e\n    \u003cp align=\"center\"\u003e\n        \u003cstrong\u003e\n            \u003ca href=\"https://octabyte.io/FireO/\"\u003eGet Started!\u003c/a\u003e\n        \u003c/strong\u003e\n    \u003c/p\u003e\n    \u003cbr\u003e\u003cbr\u003e\u003cbr\u003e\n\u003c/p\u003e\n\n## Available in other language\n\n1. FireO is available also in `nodeJS` [FireO nodeJS](https://github.com/octabytes/fireo-nodejs)\n\n## Installation\n\n```python\npip install fireo\n```\n\n## Example Usage\n\n```python\nfrom fireo.models import Model\nfrom fireo.fields import TextField\n\nclass User(Model):\n    name = TextField()\n\n\nu = User()\nu.name = \"Azeem Haider\"\nu.save()\n\n# Get user\nuser = User.collection.get(u.key)\nprint(user.name)\n```\n\n## With Typed Model\n\n```python\nfrom fireo.typedmodels import TypedModel\n\nclass User(TypedModel):\n    name: str\n    age: int\n\n# Use the model as usual:\nuser = User(name='John', age=\"30\")\nuser.save()\n\nprint(user.to_dict())\n```\n\n## Documentation\n\nFull documentation is available in the [FireO Doc](https://octabyte.io/FireO/).\n\n## Contributing\n\nBug reports and pull requests are welcome. This project is intended to be a safe, welcoming\nspace for collaboration, and contributors are expected to adhere to the\n[Contributor Covenant](https://github.com/octabytes/FireO/blob/master/CODE_OF_CONDUCT.md) code of conduct.\n\n1. Fix bug or add new features\n2. Write tests for your functionality\n3. Mention in [Documentation](https://github.com/octabytes/FireO/tree/gh-pages), what you have done and how others can use it\n\nTo run the tests while developing on this package, you'll have to setup a Google service account and setup credentials with the following command:\n\n`export GOOGLE_APPLICATION_CREDENTIALS=\"KEY_PATH\"`\n\nSee the [Google Cloud documentation](https://cloud.google.com/docs/authentication/getting-started) for more details.\n\n## Code Contributors\n\nThis project exists thanks to all the people who contribute. [[Contribute](CONTRIBUTING.md)].\n\u003ca href=\"https://github.com/octabytes/FireO/graphs/contributors\"\u003e\u003cimg src=\"https://opencollective.com/FireO/contributors.svg?width=890\u0026button=false\" /\u003e\u003c/a\u003e\n\n## License\n\nThis is official [FireO](https://github.com/octabytes/FireO) Repository. Powered by [OctaByte](https://octabyte.io)\nLicensed under [Apache License 2.0](https://github.com/octabytes/FireO/blob/master/LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foctabyte-io%2Ffireo","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Foctabyte-io%2Ffireo","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foctabyte-io%2Ffireo/lists"}