From e51a5b3d0f2c7580c7993f33ceec0d9a9e25cb6b Mon Sep 17 00:00:00 2001 From: Janet Revell Date: Thu, 8 Aug 2024 16:35:22 -0700 Subject: [PATCH 1/2] Clarify Python version prerequisite --- _includes/python-versions.md | 8 ++++++++ api-docs/reporting-api-to-overview-dashboards.md | 2 +- soda-library/install.md | 4 +++- soda-library/programmatic.md | 4 +++- soda/connect-troubleshoot.md | 1 + soda/quick-start-databricks.md | 5 ++++- soda/quick-start-migration.md | 2 +- soda/quick-start-prod.md | 2 +- soda/quick-start-sip.md | 2 +- soda/route-failed-rows.md | 2 +- soda/setup-guide.md | 4 ++-- 11 files changed, 26 insertions(+), 10 deletions(-) create mode 100644 _includes/python-versions.md diff --git a/_includes/python-versions.md b/_includes/python-versions.md new file mode 100644 index 00000000..f347accc --- /dev/null +++ b/_includes/python-versions.md @@ -0,0 +1,8 @@ +
+ Python versions Soda supports + Soda officially supports Python versions 3.8, 3.9, and 3.10.
+ Efforts to fully support Python 3.11 and 3.12 are ongoing. +

+ Using Python 3.11, some users might have some issues with dependencies constraints. At times, extra the combination of Python 3.11 and dependencies constraints requires that a dependency be built from source rather than downloaded pre-built.

+ The same applies to Python 3.12, although there is some anecdotal evidence that indicates that 3.12 might not work in all scenarios due to dependencies constraints. +
\ No newline at end of file diff --git a/api-docs/reporting-api-to-overview-dashboards.md b/api-docs/reporting-api-to-overview-dashboards.md index 092e8b4e..ce9fa110 100644 --- a/api-docs/reporting-api-to-overview-dashboards.md +++ b/api-docs/reporting-api-to-overview-dashboards.md @@ -25,7 +25,7 @@ This article offers an example for building a data quality reporting dashboard u ## Prerequisites and limitations * You have some knowledge of Python and are familiar with `pandas` and HTTP request libraries such as `httpx`. -* You have installed Python 3.8 or later. +* You have installed Python 3.8, 3.9, or 3.10. * You have a Soda Cloud account. * You have [installed Soda Library]({% link soda-library/install.md %}) in your environment and [connected]({% link soda-library/install.md %}#configure-soda) it to your Soda Cloud account. * You have used Soda Library to run at least one scan against data in a dataset. diff --git a/soda-library/install.md b/soda-library/install.md index af64da2b..598bae62 100644 --- a/soda-library/install.md +++ b/soda-library/install.md @@ -39,11 +39,13 @@ As a step in the **Get started roadmap**, this guide offers instructions to set To use Soda Library, you must have installed the following on your system. -* Python 3.8 or greater. To check your existing version, use the CLI command: `python --version` or `python3 --version`
+* Python 3.8, 3.9, or 3.10. To check your existing version, use the CLI command: `python --version` or `python3 --version`
If you have not already installed Python, consider using pyenv to manage multiple versions of Python in your environment. * Pip 21.0 or greater. To check your existing version, use the CLI command: `pip --version` * A Soda Cloud account; see next section. +{% include python-versions.md %} + ## Create a Soda Cloud account 1. In a browser, navigate to cloud.soda.io/signup to create a new Soda account, which is free for a 45-day trial. If you already have a Soda account, log in. diff --git a/soda-library/programmatic.md b/soda-library/programmatic.md index 63319851..5b675da1 100644 --- a/soda-library/programmatic.md +++ b/soda-library/programmatic.md @@ -34,10 +34,12 @@ As a step in the **Get started roadmap**, this guide offers instructions to set To use Soda Library, you must have installed the following on your system. -* Python 3.8 or greater +* Python 3.8, 3.9, or 3.10 * Pip 21.0 or greater * A Soda Cloud account; see next section. +{% include python-versions.md %} + ## Create a Soda Cloud account 1. In a browser, navigate to cloud.soda.io/signup to create a new Soda account, which is free for a 45-day trial. If you already have a Soda account, log in. diff --git a/soda/connect-troubleshoot.md b/soda/connect-troubleshoot.md index 947aeaf9..0a4d9282 100644 --- a/soda/connect-troubleshoot.md +++ b/soda/connect-troubleshoot.md @@ -12,6 +12,7 @@ Last modified on {% last_modified_at %} [Snowflake proxy connection error](#go-further)
[Spark DataFrame object error](#spark-dataframe-object-error)
[ImportError during programmatic scan](#importerror-during-programmatic-scan)
+[Scan error with Soda Dask and Pandas](#scan-error-with-soda-dask-and-pandas)
[Go further](#go-further)

diff --git a/soda/quick-start-databricks.md b/soda/quick-start-databricks.md index 6ae5f46c..0e0bfef2 100644 --- a/soda/quick-start-databricks.md +++ b/soda/quick-start-databricks.md @@ -34,9 +34,12 @@ To validate your account license or free trial, Soda Library must communicate wi ## Set up Soda Soda Library has the following requirements: -* Python 3.8 or greater +* Python 3.8, 3.9, or 3.10 * Pip 21.0 or greater +{% include python-versions.md %} + +
Download the notebook: Soda Databricks notebook {% include code-header.html %} diff --git a/soda/quick-start-migration.md b/soda/quick-start-migration.md index a43b1fa3..44619575 100644 --- a/soda/quick-start-migration.md +++ b/soda/quick-start-migration.md @@ -51,7 +51,7 @@ What follows is an abridged version of installing and configuring Soda for Postg 1. In a browser, navigate to cloud.soda.io/signup to create a new Soda account, which is free for a 45-day trial. If you already have a Soda account, log in. 2. Navigate to **your avatar** > **Profile**, then access the **API keys** tab. Click the plus icon to generate new API keys. Copy+paste the API key values to a temporary, secure place in your local environment. -3. With Python 3.8 or greater and Pip 21.0 or greater, use the command-line to install Soda locally in a new virtual environment. +3. With Python 3.8, 3.9, or 3.10 and Pip 21.0 or greater, use the command-line to install Soda locally in a new virtual environment. ```shell python3 -m venv .venv source .venv/bin/activate diff --git a/soda/quick-start-prod.md b/soda/quick-start-prod.md index bba91021..36126a74 100644 --- a/soda/quick-start-prod.md +++ b/soda/quick-start-prod.md @@ -44,7 +44,7 @@ Borrow from this guide to connect to your own data source, set up scan points in ## Install Soda from the command-line -With Python 3.8 installed, the Engineer creates a virtual environment in Terminal, then installs the Soda package for PostgreSQL using the following command. +With Python 3.8, 3.9, or 3.10 installed, the Engineer creates a virtual environment in Terminal, then installs the Soda package for PostgreSQL using the following command. {% include code-header.html %} ```shell diff --git a/soda/quick-start-sip.md b/soda/quick-start-sip.md index b169f8ec..f0f8ac97 100644 --- a/soda/quick-start-sip.md +++ b/soda/quick-start-sip.md @@ -30,7 +30,7 @@ Use the example data in this quick tutorial to set up and run a simple Soda scan This tutorial references a MacOS environment. 1. Check the following prerequisites: -* You have installed Python 3.8 or greater. +* You have installed Python 3.8, 3.9, or 3.10. * You have installed Pip 21.0 or greater. * (Optional) You have installed Docker Desktop and have access to GitHub , to set up an example data source. 2. Visit https://cloud.soda.io/signup to sign up for a Soda Cloud account which is free for a 45-day trial.
diff --git a/soda/route-failed-rows.md b/soda/route-failed-rows.md index d4120fbc..fb9a00a5 100644 --- a/soda/route-failed-rows.md +++ b/soda/route-failed-rows.md @@ -22,7 +22,7 @@ See also: [Examine failed row samples]({% link soda-cloud/failed-rows.md %})
✅ **Data migration**: Migrate good-quality data from one data source to another. See: [Test before data migration]({% link soda/quick-start-migration.md %})
Requirements: -* Python 3.8 or greater +* Python 3.8, 3.9, or 3.10 * Pip 21.0 or greater * Login credentials for your data source (Snowflake, Athena, MS SQL Server, etc.) @@ -122,7 +122,7 @@ Use this setup for:
✅ **Databricks Notebook**: Invoke Soda data quality scans in a Databricks Notebook. See: [Add Soda to a Databricks notebook]({% link soda/quick-start-databricks.md %})
Requirements: -* Python 3.8 or greater +* Python 3.8, 3.9, or 3.10 * Pip 21.0 or greater * Login credentials for your data source (Snowflake, Athena, MS SQL Server, etc.) From e12fc7a169afabeb723f71bd47e77d3553d340f8 Mon Sep 17 00:00:00 2001 From: Janet Revell Date: Thu, 8 Aug 2024 16:36:47 -0700 Subject: [PATCH 2/2] updated changelog --- soda/new-documentation.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/soda/new-documentation.md b/soda/new-documentation.md index 1ec9a7dd..b0c2e260 100644 --- a/soda/new-documentation.md +++ b/soda/new-documentation.md @@ -9,6 +9,9 @@ parent: Learning resources
+#### August 8, 2024 +* Added content to clarify that Soda Library officially supports Python 3.8, 3.9, and 3.10. + #### August 2, 2024 * Added [release notes]({% link release-notes/all.md %}) documentation for Soda Library 1.5.23 and Soda Agent 1.1.23.