Skip to content

Commit 2c18633

Browse files
committed
chore(readme): rename information and migration
1 parent 1941bf3 commit 2c18633

3 files changed

Lines changed: 51 additions & 5 deletions

File tree

.github/workflows/prerelease.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ name: prerelease
22

33
on:
44
release:
5-
types: [ prereleased ]
5+
types: [ prereleased, released ]
66

77
permissions:
88
contents: write
@@ -23,15 +23,15 @@ jobs:
2323
id: version
2424
run: echo ::set-output name=value::${GITHUB_REF#refs/*/}
2525

26-
- name: Setup Python 3.10
26+
- name: Setup Python
2727
uses: actions/setup-python@v5
2828
with:
29-
python-version: '3.10'
29+
python-version: '3.11'
3030

3131
- name: Install dependencies
3232
run: |
3333
python -m pip install --upgrade pip
34-
python -m pip install wheel
34+
python -m pip install "setuptools<80" wheel
3535
3636
- name: Build package
3737
run: make package version=${{ steps.version.outputs.value }}

README.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
> **`ydata-synthetic` is now `fg-data-synthetic`.** This package has been renamed to `fg-data-synthetic`. Please follow the [Migration Guide](#migration-guide) as soon as possible — the old package will no longer receive updates or bug fixes.
2+
3+
14
![](https://img.shields.io/github/workflow/status/ydataai/ydata-synthetic/prerelease)
25
![](https://img.shields.io/pypi/status/ydata-synthetic)
36
[![](https://pepy.tech/badge/ydata-synthetic)](https://pypi.org/project/ydata-synthetic/)
@@ -18,6 +21,40 @@ A package to generate synthetic tabular and time-series data leveraging the stat
1821
> - A new streamlit app that delivers the synthetic data generation experience with a UI interface. A low code experience for the quick generation of synthetic data
1922
> - A new fast synthetic data generation model based on Gaussian Mixture. So you can quickstart in the world of synthetic data generation without the need for a GPU.
2023
> - A conditional architecture for tabular data: CTGAN, which will make the process of synthetic data generation easier and with higher quality!
24+
25+
26+
## Migration Guide
27+
28+
### 1. Uninstall the old package
29+
30+
```bash
31+
pip uninstall ydata-synthetic
32+
```
33+
34+
### 2. Install the new package
35+
36+
```bash
37+
pip install fg-data-synthetic
38+
```
39+
40+
### 3. Update your imports
41+
42+
Find and replace all occurrences of the old import in your codebase:
43+
44+
```python
45+
# Before
46+
import ydata_synthetic
47+
from ydata_synthetic.synthesizers.regular import RegularSynthesizer
48+
49+
# After
50+
import data_synthetic
51+
from data_synthetic.synthesizers.regular import RegularSynthesizer
52+
```
53+
54+
You can use this one-liner to find all affected files:
55+
56+
```bash
57+
grep -r "ydata_synthetic" . --include="*.py"
2158

2259
## Synthetic data
2360
### What is synthetic data?

src/ydata_synthetic/__init__.py

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,10 @@
1-
#from .version import __version__
1+
#from .version import __version__
2+
3+
warn(
4+
"""
5+
`import ydata_synthetic` is deprecated and will not receive more updates.
6+
Please install fg-data-synthetic via `pip install fg-data-synthetic` and use `import data_synthetic` instead.
7+
""",
8+
DeprecationWarning,
9+
stacklevel=2,
10+
)

0 commit comments

Comments
 (0)