Skip to content
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

docs: update the IPython Magics docs #27

Merged
merged 4 commits into from
May 9, 2024
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 24 additions & 2 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ Unsupported Python Versions
Python == 2.7, Python == 3.5, Python == 3.6.

The last version of this library compatible with Python 2.7 and 3.5 is
`google-cloud-bigquery==1.28.0`.
`bigquery-magics==0.1.0`.

ashleyxuu marked this conversation as resolved.
Show resolved Hide resolved

Mac/Linux
Expand All @@ -81,4 +81,26 @@ Windows
pip install virtualenv
virtualenv <your-env>
<your-env>\Scripts\activate
<your-env>\Scripts\pip.exe install bigquery-magics
<your-env>\Scripts\pip.exe install bigquery-magics

Example Usage
-------------

To use these magics, you must first register them. Run the ``%load_ext bigquery-magic``
ashleyxuu marked this conversation as resolved.
Show resolved Hide resolved
in a Jupyter notebook cell.

.. code-block::

%load_ext bigquery-magics
ashleyxuu marked this conversation as resolved.
Show resolved Hide resolved

Perform a query
~~~~~~~~~~~~~~~

.. code:: python

%%bigquery
SELECT name, SUM(number) as count
FROM 'bigquery-public-data.usa_names.usa_1910_current'
GROUP BY name
ORDER BY count DESC
LIMIT 3
141 changes: 0 additions & 141 deletions docs/README.rst

This file was deleted.

1 change: 1 addition & 0 deletions docs/README.rst
12 changes: 0 additions & 12 deletions docs/bigquery/legacy_proto_types.rst

This file was deleted.

7 changes: 0 additions & 7 deletions docs/bigquery/standard_sql.rst

This file was deleted.

50 changes: 0 additions & 50 deletions docs/dbapi.rst

This file was deleted.

11 changes: 0 additions & 11 deletions docs/design/index.rst

This file was deleted.

115 changes: 0 additions & 115 deletions docs/design/query-retries.md

This file was deleted.

6 changes: 0 additions & 6 deletions docs/enums.rst

This file was deleted.

6 changes: 0 additions & 6 deletions docs/format_options.rst

This file was deleted.

Loading