docs: add code samples for Jupyter/IPython magics #1013
Conversation
Note: jupyter_tutorial_test.py is a copy of what is in the `samples/snippets` folder. Once the docs have been updated to point to this new version, we can remove that copy and remove the Jupyter/IPython depedencencies from `samples/snippets/requirements.txt`.
|
Here is the summary of changes. You are about to add 4 region tags.
This comment is generated by snippet-bot.
|
| @@ -0,0 +1,147 @@ | |||
| # Copyright 2018 Google Inc. All Rights Reserved. | |||
There was a problem hiding this comment.
I'm aware that this uses the natality dataset, which I think is on our list to migrate away from, but this is just to move the sample into a different directory from here: https://github.com/googleapis/python-bigquery/blob/main/samples/snippets/jupyter_tutorial_test.py
Samples are used here: https://cloud.google.com/bigquery/docs/visualize-jupyter
Possible we'll want to make this a regular notebook instead and put it here: https://github.com/GoogleCloudPlatform/bigquery-notebooks
There was a problem hiding this comment.
I think we can go ahead with existing samples using natality as long as we circle back to it eventually.
I think that this would be a good candidate for a notebook when we have the embedded notebook pipeline set up. (Possibly Q4.)
There was a problem hiding this comment.
@loferris Perhaps I should remove this file from this PR? I was moving it to this directory mostly so I can cleanup the requirements.txt file in samples/snippets, but if we think we'll migrate this to a proper notebook soon-ish, then I can wait to clean that up until then.
| @@ -0,0 +1,147 @@ | |||
| # Copyright 2018 Google Inc. All Rights Reserved. | |||
There was a problem hiding this comment.
I think we can go ahead with existing samples using natality as long as we circle back to it eventually.
I think that this would be a good candidate for a notebook when we have the embedded notebook pipeline set up. (Possibly Q4.)
| # limitations under the License. | ||
| """All of the samples used in the Jupyter notebooks tutorial. | ||
|
|
||
| Written as a test to save on boilerplate, since this sample has to similate |
There was a problem hiding this comment.
This seems like a good workaround for this kind of doc, but I would be interested in converting to a notebook as writing a sample as a test seems counterintuitive to maintain and fairly different from other samples of this type.
There was a problem hiding this comment.
+1 on eventually converting to a notebook and integrating into a notebook->docs pipeline
|
@loferris Could you mark this as Approved if there are no other changes I should make? |
🤖 I have created a release \*beep\* \*boop\* --- ## [2.30.0](https://www.github.com/googleapis/python-bigquery/compare/v2.29.0...v2.30.0) (2021-11-03) ### Features * accept TableListItem where TableReference is accepted ([#1016](https://www.github.com/googleapis/python-bigquery/issues/1016)) ([fe16adc](https://www.github.com/googleapis/python-bigquery/commit/fe16adc86a170d0992c32091b349b036f8b43884)) * support Python 3.10 ([#1043](https://www.github.com/googleapis/python-bigquery/issues/1043)) ([5bbb832](https://www.github.com/googleapis/python-bigquery/commit/5bbb832a83ebb66db4b5ee740cdfc53f4df8430b)) ### Documentation * add code samples for Jupyter/IPython magics ([#1013](https://www.github.com/googleapis/python-bigquery/issues/1013)) ([61141ee](https://www.github.com/googleapis/python-bigquery/commit/61141ee0634024ad261d1595c95cd14a896fb87e)) * **samples:** add create external table with hive partitioning ([#1033](https://www.github.com/googleapis/python-bigquery/issues/1033)) ([d64f5b6](https://www.github.com/googleapis/python-bigquery/commit/d64f5b682854a2293244426316890df4ab1e079e)) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please).
Follow-up to GoogleCloudPlatform/python-docs-samples#6889, which removed a BigQuery magics sample for using query parameters. Note: jupyter_tutorial_test.py is a copy of what is in the `samples/snippets` folder. Once the docs have been updated to point to this new version, we can remove that copy and remove the Jupyter/IPython depedencencies from `samples/snippets/requirements.txt`. Thank you for opening a Pull Request! Before submitting your PR, there are a few things you can do to make sure it goes smoothly: - [ ] Make sure to open an issue as a [bug/issue](https://github.com/googleapis/python-bigquery/issues/new/choose) before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea - [ ] Ensure the tests and linter pass - [ ] Code coverage does not decrease (if any source code was changed) - [ ] Appropriate docs were updated (if necessary)
🤖 I have created a release \*beep\* \*boop\* --- ## [2.30.0](https://www.github.com/googleapis/python-bigquery/compare/v2.29.0...v2.30.0) (2021-11-03) ### Features * accept TableListItem where TableReference is accepted ([googleapis#1016](https://www.github.com/googleapis/python-bigquery/issues/1016)) ([fe16adc](https://www.github.com/googleapis/python-bigquery/commit/fe16adc86a170d0992c32091b349b036f8b43884)) * support Python 3.10 ([googleapis#1043](https://www.github.com/googleapis/python-bigquery/issues/1043)) ([5bbb832](https://www.github.com/googleapis/python-bigquery/commit/5bbb832a83ebb66db4b5ee740cdfc53f4df8430b)) ### Documentation * add code samples for Jupyter/IPython magics ([googleapis#1013](https://www.github.com/googleapis/python-bigquery/issues/1013)) ([61141ee](https://www.github.com/googleapis/python-bigquery/commit/61141ee0634024ad261d1595c95cd14a896fb87e)) * **samples:** add create external table with hive partitioning ([googleapis#1033](https://www.github.com/googleapis/python-bigquery/issues/1033)) ([d64f5b6](https://www.github.com/googleapis/python-bigquery/commit/d64f5b682854a2293244426316890df4ab1e079e)) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please).
Follow-up to GoogleCloudPlatform/python-docs-samples#6889, which removed a BigQuery magics sample for using query parameters.
Note: jupyter_tutorial_test.py is a copy of what is in the
samples/snippetsfolder. Once the docs have been updated to point to this new version, we can
remove that copy and remove the Jupyter/IPython depedencencies from
samples/snippets/requirements.txt.Thank you for opening a Pull Request! Before submitting your PR, there are a few things you can do to make sure it goes smoothly: