Skip to content

Commit 1341dac

Browse files
committed
chore(readme): add package rename and migration guide
1 parent 82479e9 commit 1341dac

4 files changed

Lines changed: 51 additions & 4 deletions

File tree

.github/workflows/pull-request.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,7 @@ jobs:
5757
run: |
5858
python -m pip install --upgrade pip
5959
python -m pip install ".[dev,test]"
60+
python -m pip install "setuptools<80"
6061
6162
- name: Install pre-commit hooks
6263
run: pre-commit install --install-hooks

.github/workflows/tests.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ jobs:
5252
restore-keys: |
5353
${{ runner.os }}-${{ matrix.pandas }}-pip-
5454
- run: |
55-
pip install --upgrade pip setuptools wheel
55+
pip install --upgrade pip "setuptools<81" wheel
5656
pip install ".[test]" "${{ matrix.pandas }}" "${{ matrix.numpy }}"
5757
- run: echo "YDATA_PROFILING_NO_ANALYTICS=False" >> $GITHUB_ENV
5858
- run: make install
@@ -100,7 +100,7 @@ jobs:
100100
restore-keys: |
101101
${{ runner.os }}-${{ matrix.pandas }}-pip-
102102
- run: |
103-
pip install --upgrade pip setuptools wheel
103+
pip install --upgrade pip "setuptools<81" wheel
104104
pip install ".[test]" "${{ matrix.pandas }}" "${{ matrix.numpy }}"
105105
echo "YDATA_PROFILING_NO_ANALYTICS=False" >> $GITHUB_ENV
106106
- run: make install
@@ -115,7 +115,7 @@ jobs:
115115
restore-keys: |
116116
${{ runner.os }}-${{ matrix.pandas }}-pip-
117117
- run: |
118-
pip install --upgrade pip setuptools wheel
118+
pip install --upgrade pip "setuptools<81" wheel
119119
pip install ".[test]" "${{ matrix.pandas }}" "${{ matrix.numpy }}"
120120
- run: make install
121121
- run: make test_cov
@@ -163,7 +163,7 @@ jobs:
163163
164164
- name: Install Dependencies
165165
run: |
166-
python -m pip install -U pip setuptools wheel
166+
python -m pip install -U pip "setuptools<81" wheel
167167
pip install "pyspark~=${{ matrix.pyspark-version }}" "pyarrow>4.0.0" --no-cache-dir
168168
pip install ".[test]"
169169
# Make PySpark use this Python and bind locally; give it a safe tmp dir

README.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# ydata-profiling
22

3+
> **`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.
4+
35
[![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)
46
[![PyPI download month](https://img.shields.io/pypi/dm/ydata-profiling.svg)](https://pypi.python.org/pypi/ydata-profiling/)
57
[![](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
3335
> **Looking for a scalable solution that can fully integrate with your database systems?**<br>
3436
> 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).
3537
38+
## Migration Guide
39+
40+
### 1. Uninstall the old package
41+
42+
```bash
43+
pip uninstall ydata-profiling
44+
```
45+
46+
### 2. Install the new package
47+
48+
```bash
49+
pip install fg-data-profiling
50+
```
51+
52+
### 3. Update your imports
53+
54+
Find and replace all occurrences of the old import in your codebase:
55+
56+
```python
57+
# Before
58+
import ydata_profiling
59+
from ydata_profiling import ProfileReport
60+
61+
# After
62+
import data_profiling
63+
from data_profiling import ProfileReport
64+
```
65+
66+
You can use this one-liner to find all affected files:
67+
68+
```bash
69+
grep -r "ydata_profiling" . --include="*.py"
70+
```
71+
3672
## ▶️ Quickstart
3773

3874
### Install

src/ydata_profiling/__init__.py

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66
import warnings # isort:skip # noqa
77

88
import importlib.util # isort:skip # noqa
9+
from warnings import warn
910

1011
from ydata_profiling.compare_reports import compare # isort:skip # noqa
1112
from ydata_profiling.controller import pandas_decorator # isort:skip # noqa
@@ -25,6 +26,15 @@
2526

2627
warnings.simplefilter("ignore", category=NumbaDeprecationWarning)
2728

29+
warn(
30+
"""
31+
`import ydata_profiling` is deprecated and will not receive more updates.
32+
Please install fg-data-profiling via `pip install fg-data-profiling` and use `import data_profiling` instead.
33+
""",
34+
DeprecationWarning,
35+
stacklevel=2,
36+
)
37+
2838
__all__ = [
2939
"pandas_decorator",
3040
"ProfileReport",

0 commit comments

Comments
 (0)