Skip to content

Commit 3d85030

Browse files
tseavertseaver
authored
Prep firestore docs for repo split. (googleapis#6000)
- Move docs from 'docs/firestore' into 'firestore/docs' and leave symlink. - Harmonize / DRY 'firestore/README.rst' and 'firestore/docs/index.rst'. - Remove docs for GAPIC-generated bits (they aren't part of the surface). - Ensure that docs still build from top-level. Toward googleapis#5912.
1 parent 8512dd1 commit 3d85030

File tree

16 files changed

+84
-158
lines changed

16 files changed

+84
-158
lines changed

‎docs/firestore‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../firestore/docs/

‎docs/firestore/changelog.md‎

Lines changed: 0 additions & 1 deletion
This file was deleted.

‎docs/firestore/index.rst‎

Lines changed: 0 additions & 36 deletions
This file was deleted.

‎firestore/README.rst‎

Lines changed: 62 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1,61 +1,80 @@
11
Python Client for Google Cloud Firestore
22
========================================
33

4-
Python idiomatic client for `Cloud Firestore`_
4+
|pypi| |versions|
55

6-
.. _Cloud Firestore: https://cloud.google.com/firestore/docs/
6+
The `Google Cloud Firestore`_ API is a flexible, scalable
7+
database for mobile, web, and server development from Firebase and Google
8+
Cloud Platform. Like Firebase Realtime Database, it keeps your data in
9+
sync across client apps through realtime listeners and offers offline support
10+
for mobile and web so you can build responsive apps that work regardless of
11+
network latency or Internet connectivity. Cloud Firestore also offers seamless
12+
integration with other Firebase and Google Cloud Platform products,
13+
including Cloud Functions.
714

8-
- `Documentation`_
15+
- `Product Documentation`_
16+
- `Client Library Documentation`_
917

10-
.. _Documentation: https://googlecloudplatform.github.io/google-cloud-python/latest/firestore/client.html
18+
.. |pypi| image:: https://img.shields.io/pypi/v/google-cloud-firestore.svg
19+
:target: https://pypi.org/project/google-cloud-firestore/
20+
.. |versions| image:: https://img.shields.io/pypi/pyversions/google-cloud-firestore.svg
21+
.. _Google Cloud Firestore: https://cloud.google.com/firestore/
22+
.. _Product Documentation: https://cloud.google.com/firestore/docs/
23+
.. _Client Library Documentation: https://googlecloudplatform.github.io/google-cloud-python/latest/firestore/index.html
1124

1225
Quick Start
1326
-----------
1427

15-
.. code-block:: console
28+
In order to use this library, you first need to go through the following steps:
1629

17-
$ pip install --upgrade google-cloud-firestore
30+
1. `Select or create a Cloud Platform project.`_
31+
2. `Enable billing for your project.`_
32+
3. `Enable the Google Cloud Firestore API.`_
33+
4. `Setup Authentication.`_
1834

19-
For more information on setting up your Python development environment,
20-
such as installing ``pip`` and ``virtualenv`` on your system, please refer
21-
to `Python Development Environment Setup Guide`_ for Google Cloud Platform.
35+
.. _Select or create a Cloud Platform project.: https://console.cloud.google.com/project
36+
.. _Enable billing for your project.: https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project
37+
.. _Enable the Google Cloud Firestore API.: https://cloud.google.com/firestore
38+
.. _Setup Authentication.: https://googlecloudplatform.github.io/google-cloud-python/latest/core/auth.html
2239

23-
.. _Python Development Environment Setup Guide: https://cloud.google.com/python/setup
40+
Installation
41+
~~~~~~~~~~~~
2442

25-
Authentication
26-
--------------
43+
Install this library in a `virtualenv`_ using pip. `virtualenv`_ is a tool to
44+
create isolated Python environments. The basic problem it addresses is one of
45+
dependencies and versions, and indirectly permissions.
2746

28-
With ``google-cloud-python`` we try to make authentication as painless as
29-
possible. Check out the `Authentication section`_ in our documentation to
30-
learn more. You may also find the `authentication document`_ shared by all
31-
the ``google-cloud-*`` libraries to be helpful.
47+
With `virtualenv`_, it's possible to install this library without needing system
48+
install permissions, and without clashing with the installed system
49+
dependencies.
3250

33-
.. _Authentication section: https://google-cloud-python.readthedocs.io/en/latest/core/auth.html
34-
.. _authentication document: https://github.com/GoogleCloudPlatform/google-cloud-common/tree/master/authentication
51+
.. _`virtualenv`: https://virtualenv.pypa.io/en/latest/
3552

36-
Using the API
37-
-------------
3853

39-
`Cloud Firestore`_ (`Firestore API docs`_) is a flexible, scalable
40-
database for mobile, web, and server development from Firebase and Google
41-
Cloud Platform. Like Firebase Realtime Database, it keeps your data in
42-
sync across client apps through realtime listeners and offers offline support
43-
for mobile and web so you can build responsive apps that work regardless of
44-
network latency or Internet connectivity. Cloud Firestore also offers seamless
45-
integration with other Firebase and Google Cloud Platform products,
46-
including Cloud Functions.
54+
Mac/Linux
55+
^^^^^^^^^
4756

48-
.. _Firestore API docs: https://cloud.google.com/firestore/docs/
57+
.. code-block:: console
4958
50-
See the ``google-cloud-python`` API `firestore documentation`_ to learn how to
51-
interact with the Cloud Firestore using this Client Library.
59+
pip install virtualenv
60+
virtualenv <your-env>
61+
source <your-env>/bin/activate
62+
<your-env>/bin/pip install google-cloud-firestore
5263
53-
.. _firestore documentation: https://googlecloudplatform.github.io/google-cloud-python/latest/firestore/client.html
5464
55-
See the `official Cloud Firestore documentation`_ for more details on
56-
how to activate Cloud Firestore for your project.
65+
Windows
66+
^^^^^^^
5767

58-
.. _official Cloud Firestore documentation: https://cloud.google.com/firestore/docs/
68+
.. code-block:: console
69+
70+
pip install virtualenv
71+
virtualenv <your-env>
72+
<your-env>\Scripts\activate
73+
<your-env>\Scripts\pip.exe install google-cloud-firestore
74+
75+
76+
Example Usage
77+
~~~~~~~~~~~~~
5978

6079
.. code:: python
6180
@@ -76,3 +95,11 @@ how to activate Cloud Firestore for your project.
7695
7796
for doc in docs:
7897
print(u'{} => {}'.format(doc.id, doc.to_dict()))
98+
99+
Next Steps
100+
~~~~~~~~~~
101+
102+
- Read the `Client Library Documentation`_ for Google Cloud Firestore API
103+
API to see other available methods on the client.
104+
- Read the `Product Documentation`_ to learn
105+
more about the product and see How-to Guides.

docs/firestore/batch.rst renamed to firestore/docs/batch.rst

File renamed without changes.

‎firestore/docs/changelog.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../CHANGELOG.md

docs/firestore/client.rst renamed to firestore/docs/client.rst

File renamed without changes.

docs/firestore/collection.rst renamed to firestore/docs/collection.rst

File renamed without changes.

docs/firestore/constants.rst renamed to firestore/docs/constants.rst

File renamed without changes.

docs/firestore/document.rst renamed to firestore/docs/document.rst

File renamed without changes.

0 commit comments

Comments
 (0)