Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/googleapis/python-firestore

Last synced: about 4 hours ago
JSON representation

Host: GitHub
URL: https://github.com/googleapis/python-firestore
Owner: googleapis
License: apache-2.0
Created: 2019-12-10T00:09:33.000Z (about 5 years ago)
Default Branch: main
Last Pushed: 2024-10-24T01:57:20.000Z (2 months ago)
Last Synced: 2024-10-24T17:59:27.377Z (2 months ago)
Language: Python
Size: 5.01 MB
Stars: 218
Watchers: 46
Forks: 75
Open Issues: 68
Metadata Files:
- Readme: README.rst
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md

Awesome Lists containing this project

README

        Python Client for Cloud Firestore API

=====================================

|stable| |pypi| |versions|

`Cloud Firestore API`_: is a fully-managed NoSQL document database for mobile, web, and server development from Firebase and Google Cloud Platform.  It's backed by a multi-region replicated database that ensures once data is committed, it's durable even in the face of unexpected disasters. Not only that, but despite being a distributed database, it's also strongly consistent and offers seamless integration with other Firebase and Google Cloud Platform products, including Google Cloud Functions.

- `Client Library Documentation`_

- `Product Documentation`_

.. |stable| image:: https://img.shields.io/badge/support-stable-gold.svg

   :target: https://github.com/googleapis/google-cloud-python/blob/main/README.rst#stability-levels

.. |pypi| image:: https://img.shields.io/pypi/v/google-cloud-firestore.svg

   :target: https://pypi.org/project/google-cloud-firestore/

.. |versions| image:: https://img.shields.io/pypi/pyversions/google-cloud-firestore.svg

   :target: https://pypi.org/project/google-cloud-firestore/

.. _Cloud Firestore API: https://cloud.google.com/firestore

.. _Client Library Documentation: https://cloud.google.com/python/docs/reference/firestore/latest/summary_overview

.. _Product Documentation:  https://cloud.google.com/firestore

Quick Start

-----------

In order to use this library, you first need to go through the following steps:

1. `Select or create a Cloud Platform project.`_

2. `Enable billing for your project.`_

3. `Enable the Cloud Firestore API.`_

4. `Setup Authentication.`_

.. _Select or create a Cloud Platform project.: https://console.cloud.google.com/project

.. _Enable billing for your project.: https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project

.. _Enable the Cloud Firestore API.:  https://cloud.google.com/firestore

.. _Setup Authentication.: https://googleapis.dev/python/google-api-core/latest/auth.html

Installation

~~~~~~~~~~~~

Install this library in a virtual environment using `venv`_. `venv`_ is a tool that

creates isolated Python environments. These isolated environments can have separate

versions of Python packages, which allows you to isolate one project's dependencies

from the dependencies of other projects.

With `venv`_, it's possible to install this library without needing system

install permissions, and without clashing with the installed system

dependencies.

.. _`venv`: https://docs.python.org/3/library/venv.html

Code samples and snippets

~~~~~~~~~~~~~~~~~~~~~~~~~

Code samples and snippets live in the `samples/`_ folder.

.. _samples/: https://github.com/googleapis/python-firestore/tree/main/samples

Supported Python Versions

^^^^^^^^^^^^^^^^^^^^^^^^^

Our client libraries are compatible with all current `active`_ and `maintenance`_ versions of

Python.

Python >= 3.7

.. _active: https://devguide.python.org/devcycle/#in-development-main-branch

.. _maintenance: https://devguide.python.org/devcycle/#maintenance-branches

Unsupported Python Versions

^^^^^^^^^^^^^^^^^^^^^^^^^^^

Python <= 3.6

If you are using an `end-of-life`_

version of Python, we recommend that you update as soon as possible to an actively supported version.

.. _end-of-life: https://devguide.python.org/devcycle/#end-of-life-branches

Mac/Linux

^^^^^^^^^

.. code-block:: console

    python3 -m venv 

    source /bin/activate

    pip install google-cloud-firestore

Windows

^^^^^^^

.. code-block:: console

    py -m venv 

    .\\Scripts\activate

    pip install google-cloud-firestore

Next Steps

~~~~~~~~~~

-  Read the `Client Library Documentation`_ for Cloud Firestore API

   to see other available methods on the client.

-  Read the `Cloud Firestore API Product documentation`_ to learn

   more about the product and see How-to Guides.

-  View this `README`_ to see the full list of Cloud

   APIs that we cover.

.. _Cloud Firestore API Product documentation:  https://cloud.google.com/firestore

.. _README: https://github.com/googleapis/google-cloud-python/blob/main/README.rst