-
Notifications
You must be signed in to change notification settings - Fork 308
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
standardize samples directory layout #790
Comments
This is a comment from another open ticket. Consolidating here and closing that other ticket. Ideally we'd have some code samples which only require the bare minimum dependencies (no pandas, no google-cloud-bigquery-storage, no protobuf, etc). The samples/snippets directory would be perfect for this, but: There are a couple of pandas-related samples there which ideally should be moved to a samples/pandas directory. There are still code samples that haven't been moved to subdirectories: #790 |
We have an odd mix of sample locations:
docs/snippets.py
-- the original location, not very copy-pasteable / browsablesamples/*.py
, but the test drivers are insamples/tests/
samples/snippets/*.py
samples/geography/*.py
To align with the infrastructure in https://github.com/googleapis/synthtool/tree/master/synthtool/gcp/templates/python_samples, the goal is to have:
samples/snippets/
-- these samples just require thegoogle-cloud-bigquery
librarysamples/geography/
-- require extra dependencies for working with geography datasample/pandas/
-- require extra dependencies for working with pandas dataframesTo avoid breaking cloud.google.com docs, this needs to be done in several steps:
Towards: #366 (use templated noxfile) and
#765 (blacken samples using templated noxfile(s))The text was updated successfully, but these errors were encountered: