Metadata-Version: 2.4
Name: dataforgeplus
Version: 1.0.0
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, and demonstrations.

---

## ✨ Features

- 🚀 Generate thousands of records in seconds
- 📦 15 Built-in datasets
- 🛠 Custom schema support
- 📊 Returns Pandas DataFrame
- 💾 Export to CSV
- 📄 Export to JSON
- 📗 Export to Excel (.xlsx)
- 🗄 Export to SQLite
- ⚡ Fast and lightweight
- 🌍 Cross-platform

---

## 📦 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

## Built-in Dataset

```python
from dataforge import forge

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

print(df.head())
```

---

## 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 CSV

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

---

## Export Excel

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

---

## Export JSON

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

---

## Export SQLite

```python
import sqlite3

conn = sqlite3.connect("users.db")
df.to_sql("users", conn, if_exists="replace", index=False)
conn.close()
```

---

## Example Providers

```
name
email
phone
city
state
country
salary
company
uuid
gender
date
department
```

---

## Project Structure

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

---

## Roadmap

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

---

## 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, bug reports, and feature requests are welcome.

1. Fork the repository.
2. Create a new branch.
3. Commit your changes.
4. Open a Pull Request.

---

## ⭐ Support

If you find **DataForge** useful, please consider giving the repository a ⭐ on GitHub:

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