Skip to content

Commit af7ec30

Browse files
committed
README.md
1 parent 8dd7d0c commit af7ec30

3 files changed

Lines changed: 38 additions & 2 deletions

File tree

.github/workflows/merge-dev.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ on:
99

1010
permissions:
1111
id-token: write
12-
contents: read
12+
contents: write
1313
packages: read
1414

1515

.github/workflows/merge-master.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ on:
99

1010
permissions:
1111
id-token: write
12-
contents: read
12+
contents: write
1313
packages: read
1414

1515

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 `data-profiling`.** This package has been renamed to `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 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

0 commit comments

Comments
 (0)