Skip to content

Commit 86314a6

Browse files
lukesneeringerLuke Sneeringer
lukesneeringer
authored and
Luke Sneeringer
committed
Firestore v1beta1 (#420)
0 parents  commit 86314a6

57 files changed

Lines changed: 20899 additions & 0 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎packages/google-cloud-firestore/.coveragerc‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
[run]
2+
branch = True
3+
4+
[report]
5+
omit =
6+
*/firestore_v1beta1/proto/*_pb2.py
7+
*/firestore_v1beta1/proto/*_pb2_grpc.py
8+
*/firestore_v1beta1/gapic/*.py
9+
fail_under = 100
10+
show_missing = True
11+
exclude_lines =
12+
# Re-enable the standard pragma
13+
pragma: NO COVER
14+
# Ignore debug-only repr
15+
def __repr__

‎packages/google-cloud-firestore/MANIFEST.in‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
include README.rst LICENSE
2+
recursive-include google *.json *.proto
3+
recursive-include unit_tests *
4+
global-exclude *.pyc __pycache__

‎packages/google-cloud-firestore/README.rst‎

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
Python Client for Google Cloud Firestore
2+
========================================
3+
4+
Python idiomatic client for `Cloud Firestore`_
5+
6+
.. _Cloud Firestore: https://cloud.google.com/firestore/docs/
7+
8+
|pypi| |versions|
9+
10+
- `Documentation`_
11+
12+
.. _Documentation: https://googlecloudplatform.github.io/google-cloud-python/latest/firestore/client.html
13+
14+
Quick Start
15+
-----------
16+
17+
.. code-block:: console
18+
19+
$ pip install --upgrade google-cloud-firestore
20+
21+
Authentication
22+
--------------
23+
24+
With ``google-cloud-python`` we try to make authentication as painless as
25+
possible. Check out the `Authentication section`_ in our documentation to
26+
learn more. You may also find the `authentication document`_ shared by all
27+
the ``google-cloud-*`` libraries to be helpful.
28+
29+
.. _Authentication section: https://google-cloud-python.readthedocs.io/en/latest/core/auth.html
30+
.. _authentication document: https://github.com/GoogleCloudPlatform/gcloud-common/tree/master/authentication
31+
32+
Using the API
33+
-------------
34+
35+
`Cloud Firestore`_ (`Firestore API docs`_) is a flexible, scalable
36+
database for mobile, web, and server development from Firebase and Google
37+
Cloud Platform. Like Firebase Realtime Database, it keeps your data in
38+
sync across client apps through realtime listeners and offers offline support
39+
for mobile and web so you can build responsive apps that work regardless of
40+
network latency or Internet connectivity. Cloud Firestore also offers seamless
41+
integration with other Firebase and Google Cloud Platform products,
42+
including Cloud Functions.
43+
44+
.. _Firestore API docs: https://cloud.google.com/firestore/docs/
45+
46+
See the ``google-cloud-python`` API `firestore documentation`_ to learn how to
47+
interact with the Cloud Firestore using this Client Library.
48+
49+
.. _firestore documentation: https://googlecloudplatform.github.io/google-cloud-python/latest/firestore/client.html
50+
51+
See the `official Cloud Firestore documentation`_ for more details on
52+
how to activate Cloud Firestore for your project.
53+
54+
.. _official Cloud Firestore documentation: https://cloud.google.com/firestore/docs/
55+
56+
.. code:: python
57+
58+
from google.cloud import firestore
59+
60+
# Add a new document
61+
db = firestore.Client()
62+
doc_ref = db.collection(u'users').document(u'alovelace')
63+
doc_ref.set({
64+
u'first': u'Ada',
65+
u'last': u'Lovelace',
66+
u'born': 1815
67+
})
68+
69+
# Then query for documents
70+
users_ref = db.collection(u'users')
71+
docs = users_ref.get()
72+
73+
for doc in docs:
74+
print(u'{} => {}'.format(doc.id, doc.to_dict()))

‎packages/google-cloud-firestore/google/__init__.py‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Copyright 2017 Google Inc.
2+
#
3+
# Licensed under the Apache License, Version 2.0 (the "License");
4+
# you may not use this file except in compliance with the License.
5+
# You may obtain a copy of the License at
6+
#
7+
# http://www.apache.org/licenses/LICENSE-2.0
8+
#
9+
# Unless required by applicable law or agreed to in writing, software
10+
# distributed under the License is distributed on an "AS IS" BASIS,
11+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
# See the License for the specific language governing permissions and
13+
# limitations under the License.
14+
15+
try:
16+
import pkg_resources
17+
pkg_resources.declare_namespace(__name__)
18+
except ImportError:
19+
import pkgutil
20+
__path__ = pkgutil.extend_path(__path__, __name__)

‎packages/google-cloud-firestore/google/cloud/__init__.py‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Copyright 2017 Google Inc.
2+
#
3+
# Licensed under the Apache License, Version 2.0 (the "License");
4+
# you may not use this file except in compliance with the License.
5+
# You may obtain a copy of the License at
6+
#
7+
# http://www.apache.org/licenses/LICENSE-2.0
8+
#
9+
# Unless required by applicable law or agreed to in writing, software
10+
# distributed under the License is distributed on an "AS IS" BASIS,
11+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
# See the License for the specific language governing permissions and
13+
# limitations under the License.
14+
15+
try:
16+
import pkg_resources
17+
pkg_resources.declare_namespace(__name__)
18+
except ImportError:
19+
import pkgutil
20+
__path__ = pkgutil.extend_path(__path__, __name__)

‎packages/google-cloud-firestore/google/cloud/firestore.py‎

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
# Copyright 2017 Google Inc. All rights reserved.
2+
#
3+
# Licensed under the Apache License, Version 2.0 (the "License");
4+
# you may not use this file except in compliance with the License.
5+
# You may obtain a copy of the License at
6+
#
7+
# http://www.apache.org/licenses/LICENSE-2.0
8+
#
9+
# Unless required by applicable law or agreed to in writing, software
10+
# distributed under the License is distributed on an "AS IS" BASIS,
11+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
# See the License for the specific language governing permissions and
13+
# limitations under the License.
14+
15+
"""Python idiomatic client for Google Cloud Firestore."""
16+
17+
18+
from google.cloud.firestore_v1beta1 import __version__
19+
from google.cloud.firestore_v1beta1 import AdminClient
20+
from google.cloud.firestore_v1beta1 import Client
21+
from google.cloud.firestore_v1beta1 import CollectionReference
22+
from google.cloud.firestore_v1beta1 import CreateIfMissingOption
23+
from google.cloud.firestore_v1beta1 import DELETE_FIELD
24+
from google.cloud.firestore_v1beta1 import DocumentReference
25+
from google.cloud.firestore_v1beta1 import DocumentSnapshot
26+
from google.cloud.firestore_v1beta1 import enums
27+
from google.cloud.firestore_v1beta1 import ExistsOption
28+
from google.cloud.firestore_v1beta1 import GeoPoint
29+
from google.cloud.firestore_v1beta1 import LastUpdateOption
30+
from google.cloud.firestore_v1beta1 import Query
31+
from google.cloud.firestore_v1beta1 import ReadAfterWriteError
32+
from google.cloud.firestore_v1beta1 import SERVER_TIMESTAMP
33+
from google.cloud.firestore_v1beta1 import Transaction
34+
from google.cloud.firestore_v1beta1 import transactional
35+
from google.cloud.firestore_v1beta1 import types
36+
from google.cloud.firestore_v1beta1 import WriteBatch
37+
from google.cloud.firestore_v1beta1 import WriteOption
38+
39+
40+
__all__ = [
41+
'__version__',
42+
'AdminClient',
43+
'Client',
44+
'CollectionReference',
45+
'CreateIfMissingOption',
46+
'DELETE_FIELD',
47+
'DocumentReference',
48+
'DocumentSnapshot',
49+
'enums',
50+
'ExistsOption',
51+
'GeoPoint',
52+
'LastUpdateOption',
53+
'Query',
54+
'ReadAfterWriteError',
55+
'SERVER_TIMESTAMP',
56+
'Transaction',
57+
'transactional',
58+
'types',
59+
'WriteBatch',
60+
'WriteOption',
61+
]

‎packages/google-cloud-firestore/google/cloud/firestore_v1beta1/__init__.py‎

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
# Copyright 2017 Google Inc. All rights reserved.
2+
#
3+
# Licensed under the Apache License, Version 2.0 (the "License");
4+
# you may not use this file except in compliance with the License.
5+
# You may obtain a copy of the License at
6+
#
7+
# http://www.apache.org/licenses/LICENSE-2.0
8+
#
9+
# Unless required by applicable law or agreed to in writing, software
10+
# distributed under the License is distributed on an "AS IS" BASIS,
11+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
# See the License for the specific language governing permissions and
13+
# limitations under the License.
14+
15+
"""Python idiomatic client for Google Cloud Firestore."""
16+
17+
from pkg_resources import get_distribution
18+
__version__ = get_distribution('google-cloud-firestore').version
19+
20+
from google.cloud.firestore_v1beta1 import types
21+
from google.cloud.firestore_v1beta1._helpers import GeoPoint
22+
from google.cloud.firestore_v1beta1._helpers import ReadAfterWriteError
23+
from google.cloud.firestore_v1beta1.batch import WriteBatch
24+
from google.cloud.firestore_v1beta1.client import Client
25+
from google.cloud.firestore_v1beta1.client import CreateIfMissingOption
26+
from google.cloud.firestore_v1beta1.client import ExistsOption
27+
from google.cloud.firestore_v1beta1.client import LastUpdateOption
28+
from google.cloud.firestore_v1beta1.client import WriteOption
29+
from google.cloud.firestore_v1beta1.collection import CollectionReference
30+
from google.cloud.firestore_v1beta1.constants import DELETE_FIELD
31+
from google.cloud.firestore_v1beta1.constants import SERVER_TIMESTAMP
32+
from google.cloud.firestore_v1beta1.document import DocumentReference
33+
from google.cloud.firestore_v1beta1.document import DocumentSnapshot
34+
from google.cloud.firestore_v1beta1.gapic import enums
35+
from google.cloud.firestore_v1beta1.gapic import firestore_admin_client
36+
from google.cloud.firestore_v1beta1.query import Query
37+
from google.cloud.firestore_v1beta1.transaction import Transaction
38+
from google.cloud.firestore_v1beta1.transaction import transactional
39+
40+
41+
AdminClient = firestore_admin_client.FirestoreAdminClient
42+
43+
44+
__all__ = [
45+
'__version__',
46+
'AdminClient',
47+
'Client',
48+
'CollectionReference',
49+
'CreateIfMissingOption',
50+
'DELETE_FIELD',
51+
'DocumentReference',
52+
'DocumentSnapshot',
53+
'enums',
54+
'ExistsOption',
55+
'GeoPoint',
56+
'LastUpdateOption',
57+
'Query',
58+
'ReadAfterWriteError',
59+
'SERVER_TIMESTAMP',
60+
'Transaction',
61+
'transactional',
62+
'types',
63+
'WriteBatch',
64+
'WriteOption',
65+
]

0 commit comments

Comments
 (0)