Metadata-Version: 2.4
Name: dataforgeplus
Version: 1.0.1
Summary: Generate realistic synthetic datasets with a simple and powerful API.
Home-page: https://github.com/Aatif05-it/DataForge
Author: Khan Aatif
Author-email: Khan Aatif <mohdaatif9820@gmail.com>
License: MIT
Project-URL: Homepage, https://github.com/Aatif05-it/DataForge
Project-URL: Documentation, https://github.com/Aatif05-it/DataForge/wiki
Project-URL: Repository, https://github.com/Aatif05-it/DataForge
Project-URL: Issues, https://github.com/Aatif05-it/DataForge/issues
Keywords: data,dataset,synthetic-data,fake-data,generator,csv,json,excel,sqlite,testing,machine-learning,pandas,faker
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Education
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Scientific/Engineering
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: pandas>=2.2.0
Requires-Dist: Faker>=37.0.0
Requires-Dist: openpyxl>=3.1.2
Dynamic: author
Dynamic: home-page
Dynamic: license-file
Dynamic: requires-python

# 🚀 DataForge

> Generate realistic synthetic datasets with a simple and powerful API.

DataForge is a modern Python library for generating realistic synthetic datasets for testing, software development, machine learning, education, demonstrations, and AI projects.

---

## ✨ Features

- 🚀 Generate thousands of realistic records in seconds
- 📦 15 built-in datasets
- 🛠 Create custom datasets using schemas
- 📊 Returns Pandas DataFrame
- 💾 Export to CSV
- 📄 Export to JSON
- 📗 Export to Excel (.xlsx)
- 🗄 Export to SQLite
- ⚡ Fast and lightweight
- 🌍 Cross-platform
- 🐍 Python 3.10+

---

# 📦 Installation

Install from PyPI:

```bash
pip install dataforgeplus
```

Or install from source:

```bash
git clone https://github.com/Aatif05-it/DataForge.git

cd DataForge

pip install -e .
```

---

# 🚀 Quick Start

## Generate an Employee Dataset

```python
from dataforge import forge

df = forge(
    dataset="employee",
    rows=10
)

print(df.head())
```

Example Output

| Name | Email | Department | Salary |
|------|-------|------------|--------|
| John Smith | john@email.com | IT | 72000 |
| Emma Wilson | emma@email.com | HR | 61000 |

---

# 🛠 Custom Dataset

```python
from dataforge import forge

df = forge(
    rows=100,
    schema={
        "name": "name",
        "email": "email",
        "phone": "phone",
        "salary": "salary"
    }
)

print(df.head())
```

---

# 📚 Available Datasets

```python
from dataforge import available_datasets

print(available_datasets())
```

Output

```
[
'airline',
'banking',
'countries',
'creditcard',
'ecommerce',
'employee',
'hospital',
'hr',
'library',
'mobile',
'realestate',
'restaurant',
'student',
'vehicle',
'weather'
]
```

---

# 💾 Export Examples

### CSV

```python
df.to_csv("employees.csv", index=False)
```

### Excel

```python
df.to_excel("employees.xlsx", index=False)
```

### JSON

```python
df.to_json(
    "employees.json",
    orient="records",
    indent=4
)
```

### SQLite

```python
import sqlite3

conn = sqlite3.connect("employees.db")

df.to_sql(
    "employees",
    conn,
    if_exists="replace",
    index=False
)

conn.close()
```

---

# 📚 Complete Example

```python
from dataforge import forge

employees = forge(
    dataset="employee",
    rows=100
)

employees.to_csv("employees.csv", index=False)

print(employees.head())
```

---

# 🏷 Built-in Datasets

- Airline
- Banking
- Countries
- Credit Card
- Ecommerce
- Employee
- Hospital
- HR
- Library
- Mobile
- Real Estate
- Restaurant
- Student
- Vehicle
- Weather

---

# 🔧 Supported Providers

Some commonly used providers include:

```
name
first_name
last_name
email
phone
city
state
country
company
department
salary
gender
uuid
date
price
product
invoice_number
order_id
doctor
student_id
employee_id
vehicle
credit_card
passport_number
pan
aadhaar
```

---

# 📁 Project Structure

```
DataForge/
│
├── dataforge/
│   ├── __init__.py
│   ├── forge.py
│   ├── cli.py
│   ├── datasets/
│   ├── providers/
│   └── utils/
│
├── docs/
├── examples/
├── tests/
├── LICENSE
├── MANIFEST.in
├── pyproject.toml
├── setup.py
└── README.md
```

---

# 🗺 Roadmap

- ✅ CSV Export
- ✅ JSON Export
- ✅ Excel Export
- ✅ SQLite Export
- 🔜 YAML Schema Support
- 🔜 AI Dataset Generator
- 🔜 PostgreSQL Export
- 🔜 MongoDB Export
- 🔜 Parquet Export
- 🔜 REST API

---

# 📋 Requirements

- Python 3.10+
- pandas
- Faker
- openpyxl

---

# 📜 License

This project is licensed under the MIT License.

---

# 👨‍💻 Author

**Khan Aatif**

GitHub

https://github.com/Aatif05-it

---

# 🤝 Contributing

Contributions are welcome.

1. Fork the repository.
2. Create a feature branch.
3. Commit your changes.
4. Push to your fork.
5. Open a Pull Request.

---

# ⭐ Support

If you find **DataForge** useful, please consider giving the project a ⭐ on GitHub.

Repository:

https://github.com/Aatif05-it/DataForge

---

## 📧 Contact

Email:

mohdaatif9820@gmail.com
