Skip to content

Change/python support clarification #849

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

Merged
merged 2 commits into from
Aug 8, 2024
Merged
Show file tree
Hide file tree
Changes from all 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
8 changes: 8 additions & 0 deletions _includes/python-versions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
<details>
<summary style="color:#00BC7E">Python versions Soda supports</summary>
Soda officially supports Python versions 3.8, 3.9, and 3.10. <br />
Efforts to fully support Python 3.11 and 3.12 are ongoing.
<br /><br />
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. <br /><br />
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.
</details>
2 changes: 1 addition & 1 deletion api-docs/reporting-api-to-overview-dashboards.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
4 changes: 3 additions & 1 deletion soda-library/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -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` <br />
* Python 3.8, 3.9, or 3.10. To check your existing version, use the CLI command: `python --version` or `python3 --version` <br />
If you have not already installed Python, consider using <a href="https://github.com/pyenv/pyenv/wiki" target="_blank">pyenv</a> 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 <a href="https://cloud.soda.io/signup?utm_source=docs" target="_blank">cloud.soda.io/signup</a> to create a new Soda account, which is free for a 45-day trial. If you already have a Soda account, log in.
Expand Down
4 changes: 3 additions & 1 deletion soda-library/programmatic.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <a href="https://cloud.soda.io/signup?utm_source=docs" target="_blank">cloud.soda.io/signup</a> to create a new Soda account, which is free for a 45-day trial. If you already have a Soda account, log in.
Expand Down
1 change: 1 addition & 0 deletions soda/connect-troubleshoot.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ Last modified on {% last_modified_at %}
[Snowflake proxy connection error](#go-further)<br />
[Spark DataFrame object error](#spark-dataframe-object-error)<br />
[ImportError during programmatic scan](#importerror-during-programmatic-scan)<br />
[Scan error with Soda Dask and Pandas](#scan-error-with-soda-dask-and-pandas)<br />
[Go further](#go-further)<br />
<br />

Expand Down
3 changes: 3 additions & 0 deletions soda/new-documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,9 @@ parent: Learning resources

<br />

#### 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.

Expand Down
5 changes: 4 additions & 1 deletion soda/quick-start-databricks.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 %}

<br />
Download the notebook: <a href="soda-databricks-notebook.ipynb" download>Soda Databricks notebook</a>

{% include code-header.html %}
Expand Down
2 changes: 1 addition & 1 deletion soda/quick-start-migration.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ What follows is an abridged version of installing and configuring Soda for Postg

1. In a browser, navigate to <a href="https://cloud.soda.io/signup" target="_blank">cloud.soda.io/signup</a> 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
Expand Down
2 changes: 1 addition & 1 deletion soda/quick-start-prod.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion soda/quick-start-sip.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <a href="https://www.python.org/downloads/" target="_blank">Python 3.8</a> 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 <a href="https://www.docker.com/products/docker-desktop/" target="_blank">Docker Desktop</a> and have access to <a href="https://github.com/" target="_blaak">GitHub </a>, to set up an example data source.
2. Visit <a href="https://cloud.soda.io/signup" target="_blank">https://cloud.soda.io/signup</a> to sign up for a Soda Cloud account which is free for a 45-day trial.<br />
Expand Down
2 changes: 1 addition & 1 deletion soda/route-failed-rows.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ See also: [Examine failed row samples]({% link soda-cloud/failed-rows.md %})<br

## Prerequisites
* a code or text editor such as PyCharm or Visual Studio Code
* Python 3.8 or greater
* Python 3.8, 3.9, or 3.10
* Pip 21.0 or greater


Expand Down
4 changes: 2 additions & 2 deletions soda/setup-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ Use this setup for: <br />
✅ **Data migration**: Migrate good-quality data from one data source to another. See: [Test before data migration]({% link soda/quick-start-migration.md %})<br />

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.)

Expand Down Expand Up @@ -122,7 +122,7 @@ Use this setup for:<br />
✅ **Databricks Notebook**: Invoke Soda data quality scans in a Databricks Notebook. See: [Add Soda to a Databricks notebook]({% link soda/quick-start-databricks.md %})<br />

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.)

Expand Down