Skip to content

docs: use restructured text to allow publishing to PyPI #1565

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.

Sign up for GitHub

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

Merged
merged 5 commits into from
Mar 31, 2025
Merged

docs: use restructured text to allow publishing to PyPI #1565

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
6819a1e
docs: use restructured text to avoid PyPI security
tswast Mar 28, 2025
0886824
change warning to a header
tswast Mar 28, 2025
38e9f68
fix link
tswast Mar 28, 2025
273b343
add space for link
tswast Mar 28, 2025
a2dc3e2
Merge branch 'main' into tswast-readme-syntax
tswast Mar 28, 2025
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
39 changes: 23 additions & 16 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,22 +12,29 @@ powered by the BigQuery engine.
BigQuery DataFrames is an open-source package. You can run
``pip install --upgrade bigframes`` to install the latest version.

.. raw:: html

<div style="border: 1px solid #f5c6cb;
background-color: #f8d7da; color: #721c24; padding: 15px; margin-bottom: 20px; border-radius: 4px; font-size: 90%;">
<p style="margin-top: 0; font-weight: bold;">⚠️ Breaking Changes in BigQuery DataFrames v2.0</p>
<p>Version 2.0 introduces breaking changes for improved security and performance. Key default behaviors have changed:</p>
<ul>
<li><strong>Large Results (&gt;10GB):</strong> The default value for <code>allow_large_results</code> has changed to False. Methods like <code>to_pandas()</code> will now fail if the query result's compressed data size exceeds 10GB, unless large results are explicitly permitted.</li>
<li><strong>Remote Function Security:</strong>The library no longer automatically lets the Compute Engine default service account become the identity of the Cloud Run functions. If that is desired, it has to be indicated by passing cloud_function_service_account="default". And network ingress now defaults to "internal-only".</li>
<li><strong>@remote_function Argument Passing:</strong> Arguments other than input_types, output_type, and dataset to remote_function must now be passed using keyword syntax, as positional arguments are no longer supported.</li>
<li><strong>Endpoint Connections:</strong> Automatic fallback to locational endpoints in certain regions is removed. </li>
<li><strong>LLM Updates (Gemini Integration):</strong> Integrations now default to the <code>gemini-2.0-flash-001</code> model. PaLM2 support has been removed; please migrate any existing PaLM2 usage to Gemini. Note: The current default model will be removed in Version 3.0.</li>
</ul>
<p><strong>Important:</strong> If you are not ready to adapt to these changes, please pin your dependency to a version less than 2.0 (e.g., <code>bigframes==1.42.0</code>) to avoid disruption.</p>
<p style="margin-bottom: 0;"> To learn about these changes and how to migrate to version 2.0, see: <a href="https://cloud.google.com/bigquery/docs/bigquery-dataframes-introduction" style="color: #842029; text-decoration: underline;">updated introduction guide</a>.</p>
</div>
⚠️ Warning: Breaking Changes in BigQuery DataFrames v2.0
--------------------------------------------------------

Version 2.0 introduces breaking changes for improved security and performance. Key default behaviors have changed, including

* **Large Results (>10GB):** The default value for ``allow_large_results`` has changed to ``False``.
Methods like ``to_pandas()`` will now fail if the query result's compressed data size exceeds 10GB,
unless large results are explicitly permitted.
* **Remote Function Security:** The library no longer automatically lets the Compute Engine default service
account become the identity of the Cloud Run functions. If that is desired, it has to be indicated by passing
``cloud_function_service_account="default"``. And network ingress now defaults to ``"internal-only"``.
* **@remote_function Argument Passing:** Arguments other than ``input_types``, ``output_type``, and ``dataset``
to ``remote_function`` must now be passed using keyword syntax, as positional arguments are no longer supported.
* **Endpoint Connections:** Automatic fallback to locational endpoints in certain regions is removed.
* **LLM Updates (Gemini Integration):** Integrations now default to the ``gemini-2.0-flash-001`` model.
PaLM2 support has been removed; please migrate any existing PaLM2 usage to Gemini. **Note:** The current default
model will be removed in Version 3.0.

**Important:** If you are not ready to adapt to these changes, please pin your dependency to a version less than 2.0
(e.g., ``bigframes==1.42.0``) to avoid disruption.

To learn about these changes and how to migrate to version 2.0, see the
`updated introduction guide <https://cloud.google.com/bigquery/docs/bigquery-dataframes-introduction>`_.

.. |GA| image:: https://img.shields.io/badge/support-GA-gold.svg
:target: https://github.com/googleapis/google-cloud-python/blob/main/README.rst#general-availability
Expand Down
8 changes: 8 additions & 0 deletions noxfile.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -184,6 +184,14 @@ def lint_setup_py(session):
session.install("docutils", "pygments")
session.run("python", "setup.py", "check", "--restructuredtext", "--strict")

session.install("twine", "wheel")
shutil.rmtree("build", ignore_errors=True)
shutil.rmtree("dist", ignore_errors=True)
session.run("python", "setup.py", "sdist")
session.run(
"python", "-m", "twine", "check", *pathlib.Path("dist").glob("*.tar.gz")
)


def install_unittest_dependencies(session, install_test_extra, *constraints):
standard_deps = UNIT_TEST_STANDARD_DEPENDENCIES + UNIT_TEST_DEPENDENCIES
Expand Down
1 change: 1 addition & 0 deletions setup.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,6 +117,7 @@
version=version_id,
description=description,
long_description=readme,
long_description_content_type="text/x-rst",
author="Google LLC",
author_email="bigframes-feedback@google.com",
license="Apache 2.0",
Expand Down