TestDataX 0.1.0__tar.gz → 0.1.3__tar.gz

{testdatax-0.1.0 → testdatax-0.1.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: TestDataX
-Version: 0.1.0
+Version: 0.1.3
 Summary: A flexible test data generation toolkit
 License: MIT
 Author: JamesPBrett
@@ -11,6 +11,7 @@ Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Requires-Dist: faker (>=33.1.0,<34.0.0)
+Requires-Dist: mimesis (>=18.0.0,<19.0.0)
 Requires-Dist: mysql-connector-python (>=9.1.0,<10.0.0)
 Requires-Dist: orjson (>=3.10.12,<4.0.0)
 Requires-Dist: pandas (>=2.2.3,<3.0.0)
@@ -21,57 +22,35 @@ Description-Content-Type: text/markdown
 
 # TestDataX
 
+# TestDataX
+
 ![Build Status](https://github.com/JamesPBrett/testdatax/actions/workflows/publish.yml/badge.svg)
 [![codecov](https://codecov.io/gh/JamesPBrett/testdatax/branch/main/graph/badge.svg?token=6VX62CI6U9)](https://codecov.io/gh/JamesPBrett/testdatax)
 ![Python Version](https://img.shields.io/badge/python-3.11%2B-blue)
 ![License](https://img.shields.io/badge/license-MIT-blue.svg)
 
-This command-line interface application enables quick and customizable test data generation across various formats. It leverages Faker for realistic data fields, offers flexible schema configurations, and simplifies output to multiple database dialects or file types. Users can define precise parameters for data volume, types, and constraints for each target data set.
+This command-line interface application enables quick and customizable test data generation across various formats. It supports multiple data providers (Mimesis and Faker) for realistic data generation, offers flexible schema configurations, and simplifies output to multiple database dialects or file types. Users can define precise parameters for data volume, types, and constraints for each target data set.
 
 ## Requirements
 - Python 3.11+
-- Additional dependencies are handled automatically by poetry
-
-## Installation
-
-### Prerequisites
-
-```bash
-# Install Python 3.11+ if not already installed
-brew install python@3.11
-
-# Install Poetry
-curl -sSL https://install.python-poetry.org | python3 -
 
-# Verify Poetry installation
-poetry --version
-```
-
-### Install
+## Quick Start
 
 ```bash
-# Clone the repository
-git clone https://github.com/JamesPBrett/testdatax.git
-cd testdatax
-
-# Install dependencies
-poetry install
-```
+# Install from PyPI
+pip install testdatax
 
-### Common Issues
+# Generate sample data
+testdatax --rows 1000 --format json --output data.json
 
-- If Poetry is not found in PATH:
-  ```bash
-  export PATH="$HOME/.local/bin:$PATH"
-  ```
 
 ## Features
 
-- Generate realistic test data using Data providers
+- Generate realistic test data using multiple data providers (Mimesis, Faker)
 - Support for multiple output formats (CSV, JSON, SQL, etc.)
 - Customizable schema definitions
 - Configurable data generation parameters
-- CLI tool for easy data generation
+- CLI tool for easy test data generation
 
 ## Supported Formats
 
@@ -85,7 +64,7 @@ poetry install
 
 ## CLI Usage
 ```bash
-testdatax -o <output_file> -f <format> -s <schema_file> -r <num_rows> [-d]
+testdatax -o <output_file> -f <format> -s <schema_file> -r <num_rows> -p <provider> [-d]
 ```
 
 Options:
@@ -93,6 +72,7 @@ Options:
 - `-f, --format`: Output format (csv, json, orc, parquet, mysql, mssql, oracle)
 - `-r, --rows`: Number of rows to generate (default: 10)
 - `-s, --schema`: Path to schema file
+- `-p, --provider`: Data provider (mimesis, faker) - default: mimesis
 - `-d, --debug`: Enable debug output
 
 ## Usage Examples
@@ -102,10 +82,20 @@ Generate 10 rows of CSV data:
 testdatax -o users.csv -f csv -s schema.json -r 10
 ```
 
+Generate 10 rows of CSV data using Faker provider:
+```bash
+testdatax -o users.csv -f csv -s schema.json -r 10 -p faker
+```
+
 Generate 1000 rows of Parquet data with debug output:
 ```bash
 testdatax -o large_dataset.parquet -f parquet -s users_schema.json -r 1000 -d
 ```
+
+Generate 1000 rows of Parquet data using Mimesis provider:
+```bash
+testdatax -o large_dataset.parquet -f parquet -s users_schema.json -r 1000 -p mimesis
+```
 Generate JSON data with default row count (10):
 ```bash
 testdatax -o data.json -f json -s schema.json
@@ -136,6 +126,7 @@ Each command consists of:
 - `-f, --format`: Output format (csv, json, orc, parquet, mysql, mssql, oracle)
 - `-s, --schema`: Path to your schema definition file
 - `-r, --rows`: Number of rows to generate (optional, defaults to 10)
+- `-p, --provider`: Data provider (mimesis, faker) - default: mimesis
 - `-d, --debug`: Enable debug logging (optional)
 
 ## Schema Example
@@ -144,7 +135,7 @@ Each command consists of:
 {
   "username": {
     "type": "string",
-    "faker": "name"
+    "provider_field": "name"
   },
   "date_joined": {
     "type": "datetime"
@@ -191,7 +182,7 @@ The schema file defines the structure and constraints of your generated data. Ea
     "type": "string",
     "min_length": 5,
     "max_length": 20,
-    "faker": "user_name"  // Use faker to generate realistic data
+    "provider_field": "user_name"  // Use provider-specific field to generate realistic data
   },
   "description": {
     "type": "text",
@@ -244,25 +235,25 @@ The schema file defines the structure and constraints of your generated data. Ea
 }
 ```
 
-#### Using Faker
-The generator supports Faker providers for generating realistic data:
+#### Using Data Providers
+Both Mimesis and Faker providers support the same schema format. You can specify provider-specific generators using the `provider_field` field (works with both providers):
 ```json
 {
   "name": {
     "type": "string",
-    "faker": "name"
+    "provider_field": "name"
   },
   "email": {
     "type": "string",
-    "faker": "email"
+    "provider_field": "email"
   },
   "address": {
     "type": "string",
-    "faker": "address"
+    "provider_field": "address"
   },
   "company": {
     "type": "string",
-    "faker": "company"
+    "provider_field": "company"
   }
 }
 ```
@@ -276,12 +267,12 @@ The generator supports Faker providers for generating realistic data:
   },
   "username": {
     "type": "string",
-    "faker": "user_name",
+    "provider_field": "user_name",
     "unique": true
   },
   "email": {
     "type": "string",
-    "faker": "email",
+    "provider_field": "email",
     "unique": true
   },
   "age": {
@@ -306,6 +297,37 @@ The generator supports Faker providers for generating realistic data:
 }
 ```
 
+## Data Providers
+
+TestDataX supports two powerful data providers for generating realistic test data:
+
+### Mimesis (Default)
+Mimesis is a high-performance Python library for generating synthetic data. It provides:
+- Fast data generation with excellent performance
+- Support for multiple locales and languages
+- Wide variety of data providers for different domains
+- Lightweight and efficient implementation
+
+### Faker
+Faker is a popular Python library for generating fake data. It offers:
+- Extensive provider ecosystem with community contributions
+- Rich set of localized providers
+- Well-established and widely used in the Python community
+- Comprehensive documentation and examples
+
+You can specify the provider using the `-p` or `--provider` option:
+```bash
+# Use Mimesis (default)
+testdatax -o data.csv -f csv -p mimesis
+
+# Use Faker
+testdatax -o data.csv -f csv -p faker
+```
+
+Both providers support the same schema format and generate compatible data types.
+
+**Note:** For backward compatibility, the legacy `faker` field name is still supported, but `provider_field` is recommended for new schemas.
+
 ## Supported Data Types
 
 - string
@@ -341,5 +363,4 @@ The generator supports Faker providers for generating realistic data:
 ## License
 
 This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
-# Test change
 

{testdatax-0.1.0 → testdatax-0.1.3}/README.md

@@ -1,56 +1,34 @@
 # TestDataX
 
+# TestDataX
+
 ![Build Status](https://github.com/JamesPBrett/testdatax/actions/workflows/publish.yml/badge.svg)
 [![codecov](https://codecov.io/gh/JamesPBrett/testdatax/branch/main/graph/badge.svg?token=6VX62CI6U9)](https://codecov.io/gh/JamesPBrett/testdatax)
 ![Python Version](https://img.shields.io/badge/python-3.11%2B-blue)
 ![License](https://img.shields.io/badge/license-MIT-blue.svg)
 
-This command-line interface application enables quick and customizable test data generation across various formats. It leverages Faker for realistic data fields, offers flexible schema configurations, and simplifies output to multiple database dialects or file types. Users can define precise parameters for data volume, types, and constraints for each target data set.
+This command-line interface application enables quick and customizable test data generation across various formats. It supports multiple data providers (Mimesis and Faker) for realistic data generation, offers flexible schema configurations, and simplifies output to multiple database dialects or file types. Users can define precise parameters for data volume, types, and constraints for each target data set.
 
 ## Requirements
 - Python 3.11+
-- Additional dependencies are handled automatically by poetry
-
-## Installation
-
-### Prerequisites
-
-```bash
-# Install Python 3.11+ if not already installed
-brew install python@3.11
-
-# Install Poetry
-curl -sSL https://install.python-poetry.org | python3 -
 
-# Verify Poetry installation
-poetry --version
-```
-
-### Install
+## Quick Start
 
 ```bash
-# Clone the repository
-git clone https://github.com/JamesPBrett/testdatax.git
-cd testdatax
-
-# Install dependencies
-poetry install
-```
+# Install from PyPI
+pip install testdatax
 
-### Common Issues
+# Generate sample data
+testdatax --rows 1000 --format json --output data.json
 
-- If Poetry is not found in PATH:
-  ```bash
-  export PATH="$HOME/.local/bin:$PATH"
-  ```
 
 ## Features
 
-- Generate realistic test data using Data providers
+- Generate realistic test data using multiple data providers (Mimesis, Faker)
 - Support for multiple output formats (CSV, JSON, SQL, etc.)
 - Customizable schema definitions
 - Configurable data generation parameters
-- CLI tool for easy data generation
+- CLI tool for easy test data generation
 
 ## Supported Formats
 
@@ -64,7 +42,7 @@ poetry install
 
 ## CLI Usage
 ```bash
-testdatax -o <output_file> -f <format> -s <schema_file> -r <num_rows> [-d]
+testdatax -o <output_file> -f <format> -s <schema_file> -r <num_rows> -p <provider> [-d]
 ```
 
 Options:
@@ -72,6 +50,7 @@ Options:
 - `-f, --format`: Output format (csv, json, orc, parquet, mysql, mssql, oracle)
 - `-r, --rows`: Number of rows to generate (default: 10)
 - `-s, --schema`: Path to schema file
+- `-p, --provider`: Data provider (mimesis, faker) - default: mimesis
 - `-d, --debug`: Enable debug output
 
 ## Usage Examples
@@ -81,10 +60,20 @@ Generate 10 rows of CSV data:
 testdatax -o users.csv -f csv -s schema.json -r 10
 ```
 
+Generate 10 rows of CSV data using Faker provider:
+```bash
+testdatax -o users.csv -f csv -s schema.json -r 10 -p faker
+```
+
 Generate 1000 rows of Parquet data with debug output:
 ```bash
 testdatax -o large_dataset.parquet -f parquet -s users_schema.json -r 1000 -d
 ```
+
+Generate 1000 rows of Parquet data using Mimesis provider:
+```bash
+testdatax -o large_dataset.parquet -f parquet -s users_schema.json -r 1000 -p mimesis
+```
 Generate JSON data with default row count (10):
 ```bash
 testdatax -o data.json -f json -s schema.json
@@ -115,6 +104,7 @@ Each command consists of:
 - `-f, --format`: Output format (csv, json, orc, parquet, mysql, mssql, oracle)
 - `-s, --schema`: Path to your schema definition file
 - `-r, --rows`: Number of rows to generate (optional, defaults to 10)
+- `-p, --provider`: Data provider (mimesis, faker) - default: mimesis
 - `-d, --debug`: Enable debug logging (optional)
 
 ## Schema Example
@@ -123,7 +113,7 @@ Each command consists of:
 {
   "username": {
     "type": "string",
-    "faker": "name"
+    "provider_field": "name"
   },
   "date_joined": {
     "type": "datetime"
@@ -170,7 +160,7 @@ The schema file defines the structure and constraints of your generated data. Ea
     "type": "string",
     "min_length": 5,
     "max_length": 20,
-    "faker": "user_name"  // Use faker to generate realistic data
+    "provider_field": "user_name"  // Use provider-specific field to generate realistic data
   },
   "description": {
     "type": "text",
@@ -223,25 +213,25 @@ The schema file defines the structure and constraints of your generated data. Ea
 }
 ```
 
-#### Using Faker
-The generator supports Faker providers for generating realistic data:
+#### Using Data Providers
+Both Mimesis and Faker providers support the same schema format. You can specify provider-specific generators using the `provider_field` field (works with both providers):
 ```json
 {
   "name": {
     "type": "string",
-    "faker": "name"
+    "provider_field": "name"
   },
   "email": {
     "type": "string",
-    "faker": "email"
+    "provider_field": "email"
   },
   "address": {
     "type": "string",
-    "faker": "address"
+    "provider_field": "address"
   },
   "company": {
     "type": "string",
-    "faker": "company"
+    "provider_field": "company"
   }
 }
 ```
@@ -255,12 +245,12 @@ The generator supports Faker providers for generating realistic data:
   },
   "username": {
     "type": "string",
-    "faker": "user_name",
+    "provider_field": "user_name",
     "unique": true
   },
   "email": {
     "type": "string",
-    "faker": "email",
+    "provider_field": "email",
     "unique": true
   },
   "age": {
@@ -285,6 +275,37 @@ The generator supports Faker providers for generating realistic data:
 }
 ```
 
+## Data Providers
+
+TestDataX supports two powerful data providers for generating realistic test data:
+
+### Mimesis (Default)
+Mimesis is a high-performance Python library for generating synthetic data. It provides:
+- Fast data generation with excellent performance
+- Support for multiple locales and languages
+- Wide variety of data providers for different domains
+- Lightweight and efficient implementation
+
+### Faker
+Faker is a popular Python library for generating fake data. It offers:
+- Extensive provider ecosystem with community contributions
+- Rich set of localized providers
+- Well-established and widely used in the Python community
+- Comprehensive documentation and examples
+
+You can specify the provider using the `-p` or `--provider` option:
+```bash
+# Use Mimesis (default)
+testdatax -o data.csv -f csv -p mimesis
+
+# Use Faker
+testdatax -o data.csv -f csv -p faker
+```
+
+Both providers support the same schema format and generate compatible data types.
+
+**Note:** For backward compatibility, the legacy `faker` field name is still supported, but `provider_field` is recommended for new schemas.
+
 ## Supported Data Types
 
 - string
@@ -320,4 +341,3 @@ The generator supports Faker providers for generating realistic data:
 ## License
 
 This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
-# Test change

{testdatax-0.1.0 → testdatax-0.1.3}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "TestDataX"
-version = "0.1.0"
+version = "0.1.3"
 description = "A flexible test data generation toolkit"
 authors = ["JamesPBrett"]
 license = "MIT"
@@ -16,6 +16,7 @@ orjson = "^3.10.12"
 pyarrow = "^18.1.0"
 pandas = "^2.2.3"
 mysql-connector-python = "^9.1.0"
+mimesis = "^18.0.0"
 
 [tool.poetry.group.dev.dependencies]
 pytest = "^8.3.4"
@@ -119,6 +120,14 @@ warn_unreachable = true
 strict_optional = true
 plugins = ["pydantic.mypy"]
 
+[[tool.mypy.overrides]]
+module = "mimesis.*"
+ignore_missing_imports = true
+
+[[tool.mypy.overrides]]
+module = "src.providers.mimesis_provider"
+warn_return_any = false
+
 [tool.coverage.run]
 source = ["src"]
 branch = true
@@ -177,7 +186,20 @@ upload_to_repository = true
 repository = "pypi"
 tag_commit = true
 tag_format = "v{version}"
+major_on_zero = false  # Prevents 0.x.x to 1.0.0 on breaking changes
+allow_zero_version = true
 commit_message = "chore(release): v{version}"
+commit_types = [
+    { type = "feat", section = "Features", bump = "minor" },
+    { type = "fix", section = "Bug Fixes", bump = "patch" },
+    { type = "breaking", section = "Breaking Changes", bump = "major" },
+    { type = "perf", section = "Performance", bump = "patch" },
+    { type = "refactor", section = "Refactoring", bump = "patch" },
+    { type = "docs", section = "Documentation", bump = false },
+    { type = "chore", section = "Maintenance", bump = false },
+    { type = "ci", section = "CI/CD", bump = false },
+    { type = "build", section = "Build", bump = false }
+]
 
 [tool.semantic_release.changelog]
 template_dir = "templates"

{testdatax-0.1.0 → testdatax-0.1.3}/src/__init__.py

@@ -1,6 +1,6 @@
 """TestDataX package initialization."""
 
-__version__ = "0.1.0"
+__version__ = "0.1.3"
 
 from src.cli import app  # noqa
 

{testdatax-0.1.0 → testdatax-0.1.3}/src/cli.py

@@ -9,6 +9,7 @@ from .exporters.base_exporter import BaseExporter
 from .exporters.utils.constants import DEFAULT_SCHEMA, EXPORT_FORMATS
 from .exporters.utils.exporter_config import EXPORTER_CLASSES
 from .generator import DataGenerator
+from .providers import FakerProvider, MimesisProvider
 from .schemas import DataType, FieldSchema, GeneratorConfig
 
 
@@ -42,6 +43,9 @@ FORMAT_OPTION = typer.Option(
 ROWS_OPTION = typer.Option(10, "--rows", "-r", help="Number of rows to generate")
 SCHEMA_PATH_OPTION = typer.Option(None, "--schema", "-s", help="Path to schema file")
 DEBUG_OPTION = typer.Option(False, "--debug", "-d", help="Enable debug output")
+PROVIDER_OPTION = typer.Option(
+    "mimesis", "--provider", "-p", help="Data provider (faker or mimesis)"
+)
 
 
 @app.command()
@@ -51,6 +55,7 @@ def generate(
     rows: int = ROWS_OPTION,
     schema_path: Path | None = SCHEMA_PATH_OPTION,
     debug: bool = DEBUG_OPTION,
+    provider: str = PROVIDER_OPTION,
 ) -> None:
     """Generate synthetic data based on the provided schema."""
     try:
@@ -104,7 +109,8 @@ def generate(
                     min_value=min_value,
                     max_value=max_value,
                     right_digits=field_def.get("right_digits"),
-                    value_provider=field_def.get("faker"),
+                    value_provider=field_def.get("provider_field")
+                    or field_def.get("faker"),
                     pattern=field_def.get("pattern"),
                 )
                 fields.append(field_schema.model_dump())
@@ -117,6 +123,10 @@ def generate(
         if format not in EXPORT_FORMATS:
             raise ValueError(f"Unsupported format: {format}")
 
+        # Validate provider
+        if provider.lower() not in ["faker", "mimesis"]:
+            raise ValueError(f"Unsupported provider: {provider}")
+
         # Create generator config
         if debug:
             typer.echo(f"Converted fields: {fields}", err=False)
@@ -127,7 +137,12 @@ def generate(
         # Generate data
         if debug:
             typer.echo(f"Generator config: {config}", err=False)
-        generator = DataGenerator()
+
+        # Select provider
+        data_provider = (
+            MimesisProvider() if provider.lower() == "mimesis" else FakerProvider()
+        )
+        generator = DataGenerator(provider=data_provider)
         data = generator.generate_data(config.fields, config.row_count)
 
         # Export data

testdatax-0.1.3/src/providers/__init__.py

@@ -0,0 +1,5 @@
+from .base import DataProvider
+from .faker_provider import FakerProvider
+from .mimesis_provider import MimesisProvider
+
+__all__ = ["DataProvider", "FakerProvider", "MimesisProvider"]

testdatax-0.1.3/src/providers/mimesis_provider.py

@@ -0,0 +1,87 @@
+from datetime import date, datetime
+from decimal import Decimal
+from uuid import UUID
+
+from mimesis import Address, Cryptographic, Datetime, Locale, Numeric, Person, Text
+from mimesis.random import Random
+
+from .base import DataProvider
+
+
+class MimesisProvider(DataProvider):
+    """MimesisProvider generates fake data using the Mimesis library."""
+
+    def __init__(self, locale: Locale = Locale.EN) -> None:
+        """Initialize the MimesisProvider with a specific locale."""
+        self.locale = locale
+        self.person = Person(locale=locale)
+        self.address = Address(locale=locale)
+        self.text = Text(locale=locale)
+        self.numeric = Numeric()
+        self.datetime = Datetime(locale=locale)
+        self.crypto = Cryptographic()
+        self.random = Random()
+
+    def generate_string(self, **kwargs: str) -> str:
+        """Generate a fake string using the specified provider."""
+        provider = kwargs.get("value_provider") or "name"
+
+        # Map common Faker providers to Mimesis equivalents
+        provider_map = {
+            "name": lambda: self.person.full_name(),
+            "first_name": lambda: self.person.first_name(),
+            "last_name": lambda: self.person.last_name(),
+            "email": lambda: self.person.email(),
+            "username": lambda: self.person.username(),
+            "phone_number": lambda: self.person.telephone(),
+            "address": lambda: self.address.address(),
+            "company": lambda: self.person.occupation(),
+            "word": lambda: self.text.word(),
+            "sentence": lambda: self.text.sentence(),
+        }
+
+        generator = provider_map.get(provider, lambda: self.person.full_name())
+        return str(generator())
+
+    def generate_text(self, **kwargs: str) -> str:
+        """Generate a fake text string."""
+        return str(self.text.text(quantity=1))
+
+    def generate_integer(
+        self, min_value: int | None = None, max_value: int | None = None
+    ) -> int:
+        """Generate a fake integer within the specified range."""
+        min_val = min_value if min_value is not None else 0
+        max_val = max_value if max_value is not None else 100
+        return int(self.numeric.integer_number(start=min_val, end=max_val))
+
+    def generate_decimal(self, **kwargs: Decimal) -> Decimal:
+        """Generate a fake decimal number."""
+        float_val = self.numeric.float_number(start=0.0, end=999999.99)
+        return Decimal(f"{float_val:.2f}")
+
+    def generate_boolean(self) -> bool:
+        """Generate a fake boolean value."""
+        return bool(self.random.choice([True, False]))
+
+    def generate_date(self) -> date:
+        """Generate a fake date object."""
+        return self.datetime.date()
+
+    def generate_datetime(self) -> datetime:
+        """Generate a fake datetime object."""
+        return self.datetime.datetime()
+
+    def generate_binary(self, length: int = 64) -> bytes:
+        """Generate a fake binary string of the specified length."""
+        return bytes(self.random.randbytes(length))
+
+    def generate_uuid(self) -> UUID:
+        """Generate a fake UUID."""
+        return UUID(self.crypto.uuid())
+
+    def generate_enum(self, values: list[str]) -> str:
+        """Generate a fake value from the given list of values."""
+        if not values:
+            raise ValueError("Enum values cannot be empty")
+        return str(self.random.choice(values))

testdatax-0.1.0/src/providers/__init__.py

@@ -1,4 +0,0 @@
-from .base import DataProvider
-from .faker_provider import FakerProvider
-
-__all__ = ["DataProvider", "FakerProvider"]