fakedata-python 2.0.5__tar.gz → 2.1.0__tar.gz

{fakedata_python-2.0.5 → fakedata_python-2.1.0}/MANIFEST.in

@@ -1,11 +1,14 @@
 # Exclude development and Node.js files
 prune .github
 exclude CONTRIBUTING.md
+exclude data.md
 exclude CODE_OF_CONDUCT.md
 exclude .npmignore
 exclude test.js
 exclude test_py.py
 exclude test_python.py
+exclude test_new_apis.py
+exclude test_new_apis.js
 
 # Exclude JS source code
 prune src

{fakedata_python-2.0.5/fakedata_python.egg-info → fakedata_python-2.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fakedata-python
-Version: 2.0.5
+Version: 2.1.0
 Summary: The fakedata package generates realistic user profiles for machine learning, deep learning, data analysis, and data science workflows.
 Author-email: abhay557 <contact@abhaymourya.in>
 License-Expression: MIT
@@ -22,6 +22,7 @@ Dynamic: license-file
 
 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 **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.
@@ -37,6 +38,8 @@ A high-performance, **zero-dependency** synthetic data generation engine, availa
 - **Pipeline Ready**: Export directly to CSV, JSON, or Flat objects (perfect for `pandas.DataFrame`).
 - **CLI Tool**: Generate and export datasets directly from your terminal — no scripting required.
 - **Streaming Generation**: Files are written one record at a time — constant RAM usage regardless of dataset size. Generate 10M+ rows without running out of memory.
+- **Standalone Generators**: Generate modular, domain-specific data without full user profiles using `data.company()`, `data.job()`, `data.medicalRecord()`, `data.university()`, and `data.transaction()`.
+- **Enriched High-Fidelity Data**: Powered by aggregated datasets, user profiles now include structured `health.medicalHistory` arrays, `employment.companyDetails` with revenue and net income, and `employment.skills` arrays correlated to real job titles.
 
 ---
 
@@ -64,7 +67,25 @@ ts = fakedata.data.user_time_series({"days": 30, "events_per_day": 8})
 print(f"Generated {len(ts['activity'])} events for {ts['user']['fullName']}")
 ```
 
----
+### Streaming API & Custom Correlations
+Generate unlimited data lazily, keeping memory footprint at O(1), and force mathematical relationships between fields using the Pearson Correlation API:
+
+```python
+import fakedata
+
+# Create a lazy generator that yields 1 million users
+stream = fakedata.generate_stream(1000000, {
+    "correlations": [
+        {"fieldA": "education.level", "fieldB": "financial.annualIncome", "pearson_coeff": 0.85},
+        {"fieldA": "health.bmi", "fieldB": "health.bloodPressure.systolic", "pearson_coeff": 0.60}
+    ]
+})
+
+# Process users one by one without blowing up RAM
+for user in stream:
+    # write to DB, serialize to file, or process
+    pass
+```
 
 ##  Node.js / TypeScript Implementation
 
@@ -88,6 +109,26 @@ const ts = fakedata.userTimeSeries({ days: 30, eventsPerDay: 8 });
 console.log(`Generated ${ts.activity.length} events for ${ts.user.fullName}`);
 ```
 
+### Streaming API & Custom Correlations
+Generate unlimited data directly to disk while keeping memory at O(1), and force mathematical relationships between fields using the Pearson Correlation API:
+
+```javascript
+const fs = require('fs');
+const fakedata = require('@abhay557/fakedata');
+
+// Create a stream that emits 1 million users as CSV
+const stream = fakedata.data.generateStream(1000000, { 
+    format: 'csv',
+    correlations: [
+        { fieldA: 'education.level', fieldB: 'financial.annualIncome', pearson_coeff: 0.85 },
+        { fieldA: 'health.bmi', fieldB: 'health.bloodPressure.systolic', pearson_coeff: 0.60 }
+    ]
+});
+
+// Pipe directly to file (constant RAM usage)
+stream.pipe(fs.createWriteStream('1m_dataset.csv'));
+```
+
 ---
 
 ##  CLI — Command Line Interface
@@ -116,7 +157,8 @@ pip install fakedata-python
 
 | Flag | Default | Description |
 |:---|:---|:---|
-| `-n`, `--count` | `10` | Number of users to generate |
+| `-T`, `--type` | `users` | Type of data: `users` \| `companies` \| `jobs` \| `universities` \| `transactions` \| `medical_records` |
+| `-n`, `--count` | `10` | Number of records to generate |
 | `-f`, `--format` | `json` | Output format: `json` \| `csv` \| `flat` |
 | `-o`, `--output` | stdout | Output file path |
 | `-s`, `--seed` | none | Random seed for reproducibility |
@@ -133,6 +175,12 @@ pip install fakedata-python
 # Generate 1000 users and save as CSV
 fakedata generate -n 1000 -f csv -o dataset.csv
 
+# Generate 500 standalone company profiles (v2.1)
+fakedata generate --type companies -n 500 -o companies.json
+
+# Generate 100,000 medical records directly to a file (v2.1)
+fakedata generate -T medical_records -n 100000 -o hospitals.json
+
 # Generate 500 deterministic Indian users
 fakedata generate -n 500 -l in --seed 42 -o india.json
 
@@ -161,192 +209,6 @@ When writing to a file (`-o`), the CLI uses a **streaming write** strategy:
 
 This means you can generate **tens of millions of rows** without hitting Node.js heap limits or Python memory errors.
 
-```
-Before (old):  generate ALL → hold in RAM → write to file   ❌ OOM at ~500k rows
-After  (new):  open file → generate 1 → write → discard → repeat  ✅ unlimited
-```
-
----
-### 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"
-    ]
-  }
-}
-
-```
 ---
 
 ## Advanced Features Reference
@@ -406,7 +268,45 @@ These personas ensure that an analyst looking at your synthetic data will find *
 
 ## Data Structure Highlights (112 Columns)
 
-### 3. Locale-Aware Name Generation
+### 3. v2.1 High-Fidelity Data Injections
+Version 2.1 completely revamps the `user()` profile by injecting rich, deeply nested real-world data distributions for Employment, Health, and Education.
+
+```json
+{
+  "employment": {
+    "status": "employed",
+    "jobTitle": "Data Scientist",
+    "jobCategory": "Engineering",
+    "skills": ["Python", "SQL", "Machine Learning", "PyTorch"],
+    "companyDetails": {
+      "country": "United States",
+      "industry": "Technology",
+      "yearFounded": 1998,
+      "revenue": 182300000000,
+      "netIncome": 46200000000
+    }
+  },
+  "health": {
+    "medicalHistory": [
+      {
+        "condition": "Hypertension",
+        "hospital": "UCLA Medical Center",
+        "admissionType": "Urgent",
+        "billingAmount": 18560.50,
+        "medication": "Lisinopril",
+        "testResult": "Abnormal"
+      }
+    ]
+  },
+  "education": {
+    "institution": "Massachusetts Institute of Technology",
+    "institutionDomain": "mit.edu",
+    "institutionState": "Massachusetts"
+  }
+}
+```
+
+### 4. 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)
 - `'jp'`: Haruto Tanaka, Sakura Sato (+81, Japan)
@@ -417,7 +317,7 @@ Supports 8 locales with culturally accurate first names, last names, and country
 - `'fr'`: Gabriel Martin, Emma Dubois (+33, France)
 - `'en'`: James Smith, Mary Johnson (+1, United States)
 
-### 4. Time-Series Activity Data
+### 5. Time-Series Activity Data
 Generate chronological behavioral logs for users. Event types include `login`, `page_view`, `purchase`, `search`, `click`, `logout`, `api_call`, `upload`, `download`, and `comment`.
 
 ```javascript
@@ -426,7 +326,7 @@ const ts = data.userTimeSeries({ seed: 42, days: 30, eventsPerDay: 8 });
 // ts.activity → [{ timestamp, type, page, duration, device, ip, success, amount?, query? }]
 ```
 
-### 5. Anomaly Injection Engine (Fraud Detection)
+### 6. Anomaly Injection Engine (Fraud Detection)
 When `anomaly_rate` is > 0, `fakedata` injects ML-detectable fraud patterns into the dataset. Affected users receive a special `_anomaly` flag object indicating the fraud type.
 
 | Anomaly Type | Effect |
@@ -440,7 +340,7 @@ When `anomaly_rate` is > 0, `fakedata` injects ML-detectable fraud patterns into
 | `data_mismatch` | Age=12 + employed + 30yr experience + $500k income |
 | `health_outlier` | BMI = 8-9 or 75-80, BP = extreme values |
 
-### 6. The User Profile Schema (109 Correlated Fields)
+### 7. The User Profile Schema (109 Correlated Fields)
 Each generated user contains highly realistic, correlated data. For example, age determines education graduation year, which impacts employment salary, which impacts credit score, which impacts housing status and health/BMI metrics.
 
 ```text
@@ -456,7 +356,3 @@ identity(9) → personal(6) → network(3) → address(7) → demographics(5)
 Distributed under the **MIT License**. See `LICENSE` for more information.
 
 **Maintainer**: [abhay557](https://github.com/abhay557)
-
-- Project Commit History - `https://github.com/abhay557/random-api.xyz`
-
----