GoogleCloudPlatform / GoogleCloudPlatform/python-docs-samples

firestore: samples should include client creation

Open
#11,993 0 comments 1 reaction 1 assignee Assigned to @daniel-sanche View on GitHub
api: firestore priority: p3 samples triage me type: feature request
Dominant language
Jupyter Notebook
Stars
8.1k
Forks
6.7k
Avg merge
4d 2h
Merged PRs (30d)
16

Description

Currently, we have [one sample for creating a client](https://github.com/GoogleCloudPlatform/python-docs-samples/blob/4282aa905763af06354225ae0f422c09201b41da/firestore/cloud-async-client/snippets.py#L27), and the others [assume the client already exists](https://github.com/GoogleCloudPlatform/python-docs-samples/blob/4282aa905763af06354225ae0f422c09201b41da/firestore/cloud-async-client/snippets.py#L36).

This causes problems, because we have both a sync and an async client, and using the wrong client leads to errors. When the samples are viewed stand-alone, they don't give the proper context

We should instead include the creation of the client (and any important imports) as part of each sample, so they can better stand alone

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.