fakedata-python 2.0.0__tar.gz → 2.0.1__tar.gz

{fakedata_python-2.0.0 → fakedata_python-2.0.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fakedata-python
-Version: 2.0.0
+Version: 2.0.1
 Summary: The fakedata package generates realistic synthetic user profiles for machine learning, deep learning, data analysis, and data science workflows.
 Author-email: abhay557 <abhaycormourya@gmail.com>
 License-Expression: MIT
@@ -15,14 +15,17 @@ Description-Content-Type: text/markdown
 [![NPM Version](https://img.shields.io/npm/v/@abhay557/fakedata?color=red&label=npm)](https://www.npmjs.com/package/@abhay557/fakedata)
 [![PyPI Version](https://img.shields.io/pypi/v/fakedata-python?color=blue&label=pypi)](https://pypi.org/project/fakedata-python/)
 [![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](https://opensource.org/licenses/MIT)
+[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/drive/16N9x1YCOVVvIF8rl7IQxKRkK4en_g3Gi?usp=sharing)
+[![PyPI Downloads](https://static.pepy.tech/personalized-badge/fakedata-python?period=total&units=INTERNATIONAL_SYSTEM&left_color=BLACK&right_color=GREEN&left_text=downloads)](https://pepy.tech/projects/fakedata-python)
 
 A high-performance, **zero-dependency** synthetic data generation engine, available for both **Node.js** and **Python**. Designed specifically for machine learning, data science, and analytics workflows, providing 100% data parity across platforms.
 
 ## Overview
 
-`fakedata` has been completely rebuilt from the ground up to serve as an **ML-ready synthetic data engine**. It generates deeply interconnected user profiles with **109 flat columns across 13 domains** (Health, Financial, Employment, Digital Footprint, etc.), making it the perfect tool for training models, benchmarking pipelines, or simulating realistic databases.
+`fakedata` has been completely rebuilt from the ground up to serve as an **ML-ready synthetic data engine**. It generates deeply interconnected user profiles with **112 flat columns across 13 domains** (Health, Financial, Employment, Digital Footprint, etc.), making it the perfect tool for training models, benchmarking pipelines, or simulating realistic databases.
 
 ###  Machine Learning Power Features:
+- **Behavioral Personas**: Orchestrate correlations through 6 distinct personas (e.g., Executive, Student, Tech Pro) to ensure realistic socio-economic patterns.
 - **Seed Reproducibility**: Generate byte-for-byte identical datasets across runs (and languages!) using `seed`.
 - **Schema Overrides**: Force specific distributions (e.g., age ranges, income brackets, genders) using `schema`.
 - **Locale-Aware Generation**: Support for 8 culture-specific name sets and phone formats (`en`, `in`, `jp`, `kr`, `de`, `br`, `ar`, `fr`).
@@ -32,6 +35,30 @@ A high-performance, **zero-dependency** synthetic data generation engine, availa
 - **Pipeline Ready**: Export directly to CSV, JSON, or Flat objects (perfect for `pandas.DataFrame`).
 
 ---
+##  Python Implementation
+
+### Installation
+```bash
+pip install fakedata-python
+```
+
+### Quick Start
+```python
+import fakedata.data as data
+import pandas as pd
+
+# Generate 10,000 highly correlated users deterministically
+users = data.users(10000, {"seed": 42})
+
+# Or export directly to a Pandas DataFrame
+df = pd.DataFrame(data.users_flat(10000, {"seed": 42}))
+print(df.head())
+
+# Create time-series activity data
+ts = data.user_time_series({"days": 30, "events_per_day": 8})
+print(f"Generated {len(ts['activity'])} events for {ts['user']['fullName']}")
+```
+
 
 ##  Node.js / TypeScript Implementation
 
@@ -54,33 +81,188 @@ const csvString = data.usersToCSV(1000, { seed: 42 });
 const ts = data.userTimeSeries({ days: 30, eventsPerDay: 8 });
 console.log(`Generated ${ts.activity.length} events for ${ts.user.fullName}`);
 ```
-
 ---
 
-##  Python Implementation
-
-### Installation
-```bash
-pip install fakedata-python
-```
-
-### Quick Start
-```python
-import fakedata.data as data
-import pandas as pd
-
-# Generate 10,000 highly correlated users deterministically
-users = data.users(10000, {"seed": 42})
-
-# Or export directly to a Pandas DataFrame
-df = pd.DataFrame(data.users_flat(10000, {"seed": 42}))
-print(df.head())
+### sample output - one user
+```fakedata.data.user()``` 
+```fakedata.data.user(n) // set n = 100```
+
+```json
+  "id": "4612",
+  "fullName": "Damaris Carlo Ebervale",
+  "firstName": "Damaris",
+  "lastName": "Ebervale",
+  "middleName": "Carlo",
+  "age": 31,
+  "gender": "non-binary",
+  "email": "damaris.ebervale@liberomail.com",
+  "phone": "+1 7469125114",
+  "username": "damaris_4612",
+  "password": "UQ!VZr0cLUD9",
+  "birthDate": "1995-07-19",
+  "bloodGroup": "+B",
+  "height": 185,
+  "weight": 60,
+  "domain": "damarisebervale.vg",
+  "ip": "48.50.80.113",
+  "macaddress": "33:2F:39:EE:3B:1E",
+  "address": {
+    "street": "3623 Chateau Lane",
+    "city": "Kilgore",
+    "state": "Texas",
+    "country": "Sierra Leone",
+    "countryCode": "SL",
+    "zipCode": 36434,
+    "coordinates": {
+      "latitude": "-68.324385",
+      "longitude": "55.859967"
+    }
+  },
+  "demographics": {
+    "ethnicity": "Hispanic",
+    "nationality": "South Korean",
+    "language": {
+      "primary": "Arabic",
+      "secondary": "Turkish"
+    },
+    "relationshipStatus": "dating"
+  },
+  "education": {
+    "level": "Bachelor's",
+    "field": "Computer Science",
+    "institution": "Agricultural University of Lublin",
+    "institutionCountry": "Poland",
+    "gpa": 2.79,
+    "graduationYear": 2017,
+    "studentDebt": 64117
+  },
+  "employment": {
+    "status": "self-employed",
+    "company": "China CITIC Bank",
+    "companySize": "enterprise",
+    "industry": "Banking",
+    "jobTitle": "\"ORACLE DBA\"",
+    "jobCategory": "Network Engineering",
+    "yearsExperience": 10,
+    "workMode": "onsite",
+    "workHoursPerWeek": 36,
+    "jobSatisfaction": 6
+  },
+  "financial": {
+    "annualIncome": 21600,
+    "creditScore": 464,
+    "savings": 1680,
+    "monthlyExpenses": 1309,
+    "debtToIncome": 3.12,
+    "taxBracket": "12%",
+    "investmentStyle": "moderate",
+    "homeOwnership": "own"
+  },
+  "health": {
+    "bmi": 17.5,
+    "bmiCategory": "underweight",
+    "bloodPressure": {
+      "systolic": 100,
+      "diastolic": 82
+    },
+    "exerciseFrequency": "3-4 times/week",
+    "smoking": "never",
+    "alcohol": "never",
+    "sleepHoursPerNight": 8.3,
+    "sleepQuality": "poor",
+    "diet": "mediterranean",
+    "medicalCondition": "None",
+    "insuranceProvider": "UnitedHealthcare",
+    "medications": [
+      "Lisinopril"
+    ],
+    "lastCheckupMonthsAgo": 11,
+    "hasDisability": false,
+    "mentalHealth": "poor",
+    "vaccination": "partially vaccinated"
+  },
+  "social": {
+    "socialMedia": {
+      "platforms": [
+        "Pinterest",
+        "Twitter/X",
+        "Reddit",
+        "Instagram"
+      ],
+      "screenTimeHoursPerDay": 3.8,
+      "preferredContent": "video"
+    },
+    "shopping": {
+      "frequency": "weekly",
+      "preferredCategories": [
+        "toys & games",
+        "books"
+      ],
+      "monthlyOnlineSpending": 175
+    },
+    "newsSource": "social media",
+    "travelFrequency": "weekly",
+    "volunteers": false,
+    "pet": "multiple"
+  },
+  "digitalFootprint": {
+    "accountCreatedAt": "2021-04-01T09:59:41.867116+00:00",
+    "lastLoginAt": "2026-04-24T09:59:41.867116+00:00",
+    "lastPasswordChangeAt": "2025-11-06T09:59:41.867116+00:00",
+    "userAgent": "Mozilla/5.0 (Linux; Android 14; Pixel 8) AppleWebKit/537.36 Chrome/121.0.0.0 Mobile Safari/537.36",
+    "browser": "Chrome",
+    "os": "Windows 11",
+    "referrer": "facebook.com",
+    "avgSessionMinutes": 17.6,
+    "sessionsPerWeek": 10,
+    "totalSessions": 2666,
+    "twoFactorEnabled": false,
+    "preferredLanguage": "de",
+    "accountStatus": "inactive",
+    "verifiedEmail": false,
+    "verifiedPhone": true
+  },
+  "bank": {
+    "nameOnCard": "Damaris Carlo Ebervale",
+    "cardNumber": "2289970210128357",
+    "cardType": "Mastercard",
+    "cardExpiry": "5/29",
+    "cardCvv": "355"
+  },
+  "hobbies": [
+    "Knitting",
+    "Gardening",
+    "LARPing"
+  ],
+  "technology_profile": {
+    "devices": {
+      "additional_devices": [
+        "BlackBerry Bold 9790",
+        "Nokia N9"
+      ],
+      "smartphone": "Sony Ericsson Xperia X10"
+    },
+    "phone_preferences": {
+      "critical_features": [
+        "security features",
+        "reliability",
+        "5G connectivity"
+      ],
+      "primary_uses": [
+        "photography",
+        "education",
+        "organization"
+      ]
+    },
+    "interest": [
+      "Knitting",
+      "Gardening",
+      "LARPing"
+    ]
+  }
+}
 
-# Create time-series activity data
-ts = data.user_time_series({"days": 30, "events_per_day": 8})
-print(f"Generated {len(ts['activity'])} events for {ts['user']['fullName']}")
 ```
-
 ---
 
 ## Advanced Features Reference
@@ -122,9 +304,24 @@ const options = {
 | `data.users(n, opts?)` | `data.users(n, opts=None)` | Generate an array/list of `n` users. |
 | `data.userTimeSeries(opts)` | `data.user_time_series(opts)`| Returns `{ user, activity }` containing chronological event logs. |
 | `data.usersFlat(n, opts?)` | `data.users_flat(n, opts=None)`| Returns flat dicts/objects, perfect for `pandas.DataFrame` ingestion. |
-| `data.usersToCSV(n, opts?)` | `data.users_to_csv(n, opts=None)`| Returns a fully formatted CSV string (109 columns). |
+| `data.usersToCSV(n, opts?)` | `data.users_to_csv(n, opts=None)`| Returns a fully formatted CSV string (112 columns). |
 | `data.usersToJSON(n, opts?)`| `data.users_to_json(n, opts=None)`| Returns a pretty-printed JSON string. |
 
+### 3. Behavioral Personas (Statistical Modeling)
+To ensure the data is useful for **Clustering** and **Regression** analysis, `fakedata` uses a **Persona-driven engine**. Every user is assigned one of 6 personas that orchestrate their life outcomes:
+
+- **Executive**: High income, high education (Master's/PhD), premium Apple devices, luxury lifestyle.
+- **Tech Professional**: High income, high-end hardware, heavy social media use, remote work bias.
+- **Student**: Low income, high student debt, budget/mid-range tech, high social media footprint.
+- **Manual Laborer / Service Worker**: Budget-conscious, steady income, consistent employment patterns.
+- **Freelancer**: Flexible work modes, variable income ranges, mid-range tech profile.
+
+These personas ensure that an analyst looking at your synthetic data will find **statistically significant clusters** rather than just a uniform cloud of random values.
+
+---
+
+## Data Structure Highlights (112 Columns)
+
 ### 3. Locale-Aware Name Generation
 Supports 8 locales with culturally accurate first names, last names, and country/phone codes:
 - `'in'`: Aarav Sharma, Priya Patel (+91, India)