From 122d27639e66641f7862fb2c9e04e145040866bf Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lu=C3=ADs=20Portela=20Afonso?= Date: Tue, 3 Mar 2026 16:50:20 +0000 Subject: [PATCH] chore(readme): add package rename and migration guide --- .github/workflows/pull-request.yml | 1 + .github/workflows/tests.yml | 8 +++---- README.md | 36 ++++++++++++++++++++++++++++++ src/ydata_profiling/__init__.py | 10 +++++++++ 4 files changed, 51 insertions(+), 4 deletions(-) diff --git a/.github/workflows/pull-request.yml b/.github/workflows/pull-request.yml index c79843abf..826aa4065 100644 --- a/.github/workflows/pull-request.yml +++ b/.github/workflows/pull-request.yml @@ -57,6 +57,7 @@ jobs: run: | python -m pip install --upgrade pip python -m pip install ".[dev,test]" + python -m pip install "setuptools<80" - name: Install pre-commit hooks run: pre-commit install --install-hooks diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml index fc5a5c670..83f85dad1 100644 --- a/.github/workflows/tests.yml +++ b/.github/workflows/tests.yml @@ -52,7 +52,7 @@ jobs: restore-keys: | ${{ runner.os }}-${{ matrix.pandas }}-pip- - run: | - pip install --upgrade pip setuptools wheel + pip install --upgrade pip "setuptools<81" wheel pip install ".[test]" "${{ matrix.pandas }}" "${{ matrix.numpy }}" - run: echo "YDATA_PROFILING_NO_ANALYTICS=False" >> $GITHUB_ENV - run: make install @@ -100,7 +100,7 @@ jobs: restore-keys: | ${{ runner.os }}-${{ matrix.pandas }}-pip- - run: | - pip install --upgrade pip setuptools wheel + pip install --upgrade pip "setuptools<81" wheel pip install ".[test]" "${{ matrix.pandas }}" "${{ matrix.numpy }}" echo "YDATA_PROFILING_NO_ANALYTICS=False" >> $GITHUB_ENV - run: make install @@ -115,7 +115,7 @@ jobs: restore-keys: | ${{ runner.os }}-${{ matrix.pandas }}-pip- - run: | - pip install --upgrade pip setuptools wheel + pip install --upgrade pip "setuptools<81" wheel pip install ".[test]" "${{ matrix.pandas }}" "${{ matrix.numpy }}" - run: make install - run: make test_cov @@ -163,7 +163,7 @@ jobs: - name: Install Dependencies run: | - python -m pip install -U pip setuptools wheel + python -m pip install -U pip "setuptools<81" wheel pip install "pyspark~=${{ matrix.pyspark-version }}" "pyarrow>4.0.0" --no-cache-dir pip install ".[test]" # Make PySpark use this Python and bind locally; give it a safe tmp dir diff --git a/README.md b/README.md index 3c0d70051..3db9a617b 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,7 @@ # ydata-profiling +> **`ydata-profiling` is now `fg-data-profiling`.** This package has been renamed to `fg-data-profiling`. Please follow the [Migration Guide](#migration-guide) as soon as possible — the old package will no longer receive updates or bug fixes. + [![Build Status](https://github.com/ydataai/pandas-profiling/actions/workflows/tests.yml/badge.svg?branch=master)](https://github.com/ydataai/pandas-profiling/actions/workflows/tests.yml) [![PyPI download month](https://img.shields.io/pypi/dm/ydata-profiling.svg)](https://pypi.python.org/pypi/ydata-profiling/) [![](https://pepy.tech/badge/pandas-profiling)](https://pypi.org/project/ydata-profiling/) @@ -33,6 +35,40 @@ The package outputs a simple and digested analysis of a dataset, including **tim > **Looking for a scalable solution that can fully integrate with your database systems?**
> Leverage YData Fabric Data Catalog to connect to different databases and storages (Oracle, snowflake, PostGreSQL, GCS, S3, etc.) and leverage an interactive and guided profiling experience in Fabric. Check out the [Community Version](http://ydata.ai/register?utm_source=ydata-profiling&utm_medium=documentation&utm_campaign=YData%20Fabric%20Community). +## Migration Guide + +### 1. Uninstall the old package + +```bash +pip uninstall ydata-profiling +``` + +### 2. Install the new package + +```bash +pip install fg-data-profiling +``` + +### 3. Update your imports + +Find and replace all occurrences of the old import in your codebase: + +```python +# Before +import ydata_profiling +from ydata_profiling import ProfileReport + +# After +import data_profiling +from data_profiling import ProfileReport +``` + +You can use this one-liner to find all affected files: + +```bash +grep -r "ydata_profiling" . --include="*.py" +``` + ## ▶️ Quickstart ### Install diff --git a/src/ydata_profiling/__init__.py b/src/ydata_profiling/__init__.py index 4361ae291..84dc4b020 100644 --- a/src/ydata_profiling/__init__.py +++ b/src/ydata_profiling/__init__.py @@ -6,6 +6,7 @@ import warnings # isort:skip # noqa import importlib.util # isort:skip # noqa +from warnings import warn from ydata_profiling.compare_reports import compare # isort:skip # noqa from ydata_profiling.controller import pandas_decorator # isort:skip # noqa @@ -25,6 +26,15 @@ warnings.simplefilter("ignore", category=NumbaDeprecationWarning) +warn( + """ + `import ydata_profiling` is deprecated and will not receive more updates. + Please install fg-data-profiling via `pip install fg-data-profiling` and use `import data_profiling` instead. + """, + DeprecationWarning, + stacklevel=2, +) + __all__ = [ "pandas_decorator", "ProfileReport",