TestDataX 0.1.0__py3-none-any.whl

testdatax-0.1.0.dist-info/METADATA

@@ -0,0 +1,345 @@
+Metadata-Version: 2.3
+Name: TestDataX
+Version: 0.1.0
+Summary: A flexible test data generation toolkit
+License: MIT
+Author: JamesPBrett
+Requires-Python: >=3.11,<4.0
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+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: 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)
+Requires-Dist: pyarrow (>=18.1.0,<19.0.0)
+Requires-Dist: pydantic (>=2.10.4,<3.0.0)
+Requires-Dist: typer (>=0.15.1,<0.16.0)
+Description-Content-Type: text/markdown
+
+# 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.
+
+## 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
+
+```bash
+# Clone the repository
+git clone https://github.com/JamesPBrett/testdatax.git
+cd testdatax
+
+# Install dependencies
+poetry install
+```
+
+### Common Issues
+
+- If Poetry is not found in PATH:
+  ```bash
+  export PATH="$HOME/.local/bin:$PATH"
+  ```
+
+## Features
+
+- Generate realistic test data using Data providers
+- Support for multiple output formats (CSV, JSON, SQL, etc.)
+- Customizable schema definitions
+- Configurable data generation parameters
+- CLI tool for easy data generation
+
+## Supported Formats
+
+- JSON
+- CSV
+- ORC
+- Parquet
+- MySQL
+- MSSQL
+- Oracle
+
+## CLI Usage
+```bash
+testdatax -o <output_file> -f <format> -s <schema_file> -r <num_rows> [-d]
+```
+
+Options:
+- `-o, --output`: Output file path (table_name for sql exports)
+- `-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
+- `-d, --debug`: Enable debug output
+
+## Usage Examples
+
+Generate 10 rows of CSV data:
+```bash
+testdatax -o users.csv -f csv -s schema.json -r 10
+```
+
+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 JSON data with default row count (10):
+```bash
+testdatax -o data.json -f json -s schema.json
+```
+
+Generate ORC file with specific schema:
+```bash
+testdatax -o analytics.orc -f orc -s analytics_schema.json -r 100
+```
+
+Generate MySQL with default row count (1000), table_name as 'default':
+```bash
+testdatax -o default.sql -f mysql -r 1000
+```
+
+Generate MSSQL with default row count (1000), table_name as 'mstest':
+```bash
+testdatax -o mstest.sql -f mssql -r 1000
+```
+
+Generate Oracle with default row count (1000), table_name as 'oracle':
+```bash
+datagen -o oracle.sql -f oracle -r 1000
+```
+
+Each command consists of:
+- `-o, --output`: Specify the output file path and name
+- `-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)
+- `-d, --debug`: Enable debug logging (optional)
+
+## Schema Example
+
+```json
+{
+  "username": {
+    "type": "string",
+    "faker": "name"
+  },
+  "date_joined": {
+    "type": "datetime"
+  },
+  "date": {
+    "type": "date"
+  },
+  "age": {
+    "type": "integer",
+    "min": 18,
+    "max": 99
+  },
+  "is_active": {
+    "type": "boolean"
+  },
+  "float": {
+    "type": "float"
+  },
+  "uuid": {
+    "type": "uuid"
+  },
+  "status": {
+    "type": "enum",
+    "values": ["active", "inactive", "pending"]
+  }
+}
+```
+
+## Schema Configuration
+
+The schema file defines the structure and constraints of your generated data. Each field in the schema can have the following properties:
+
+### Basic Field Properties
+- `type`: (required) The data type of the field
+- `nullable`: (optional) Boolean to allow null values (default: false)
+- `unique`: (optional) Boolean to ensure unique values (default: false)
+
+### Type-Specific Properties
+
+#### String Fields
+```json
+{
+  "username": {
+    "type": "string",
+    "min_length": 5,
+    "max_length": 20,
+    "faker": "user_name"  // Use faker to generate realistic data
+  },
+  "description": {
+    "type": "text",
+    "min_length": 100,
+    "max_length": 500
+  }
+}
+```
+
+#### Numeric Fields
+```json
+{
+  "age": {
+    "type": "integer",
+    "min": 18,
+    "max": 99
+  },
+  "score": {
+    "type": "float",
+    "min": 0.0,
+    "max": 100.0,
+    "precision": 2
+  }
+}
+```
+
+#### Date and Time Fields
+```json
+{
+  "created_at": {
+    "type": "datetime",
+    "start_date": "2020-01-01",
+    "end_date": "2023-12-31"
+  },
+  "birth_date": {
+    "type": "date",
+    "format": "%Y-%m-%d"
+  }
+}
+```
+
+#### Enum Fields
+```json
+{
+  "status": {
+    "type": "enum",
+    "values": ["pending", "active", "suspended"],
+    "weights": [0.2, 0.7, 0.1]  // Optional probability weights
+  }
+}
+```
+
+#### Using Faker
+The generator supports Faker providers for generating realistic data:
+```json
+{
+  "name": {
+    "type": "string",
+    "faker": "name"
+  },
+  "email": {
+    "type": "string",
+    "faker": "email"
+  },
+  "address": {
+    "type": "string",
+    "faker": "address"
+  },
+  "company": {
+    "type": "string",
+    "faker": "company"
+  }
+}
+```
+
+### Complete Example
+```json
+{
+  "user_id": {
+    "type": "uuid",
+    "unique": true
+  },
+  "username": {
+    "type": "string",
+    "faker": "user_name",
+    "unique": true
+  },
+  "email": {
+    "type": "string",
+    "faker": "email",
+    "unique": true
+  },
+  "age": {
+    "type": "integer",
+    "min": 18,
+    "max": 99
+  },
+  "status": {
+    "type": "enum",
+    "values": ["active", "inactive"],
+    "weights": [0.8, 0.2]
+  },
+  "created_at": {
+    "type": "datetime",
+    "start_date": "2020-01-01",
+    "end_date": "2023-12-31"
+  },
+  "is_verified": {
+    "type": "boolean",
+    "nullable": true
+  }
+}
+```
+
+## Supported Data Types
+
+- string
+- text
+- integer
+- bigint
+- float
+- decimal
+- boolean
+- date
+- datetime
+- blob
+- uuid
+- enum
+
+## Database Type Mappings
+
+| Generic Type | MySQL         | MSSQL             | Oracle        |
+|--------------|---------------|-------------------|---------------|
+| string       | VARCHAR(255)  | NVARCHAR(255)     | VARCHAR2(255) |
+| text         | TEXT          | NVARCHAR(MAX)     | CLOB          |
+| integer      | INT           | INT               | NUMBER(10)    |
+| bigint       | BIGINT        | BIGINT            | NUMBER(19)    |
+| float        | FLOAT         | FLOAT             | FLOAT         |
+| decimal      | DECIMAL(18,2) | DECIMAL(18,2)     | NUMBER(18,2)  |
+| boolean      | TINYINT(1)    | BIT               | NUMBER(1)     |
+| date         | DATE          | DATE              | DATE          |
+| datetime     | DATETIME      | DATETIME2         | TIMESTAMP     |
+| blob         | LONGBLOB      | VARBINARY(MAX)    | BLOB          |
+| uuid         | VARCHAR(36)   | UNIQUEIDENTIFIER  | VARCHAR2(36)  |
+| enum         | ENUM          | NVARCHAR(255)     | VARCHAR2(255) |
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+# Test change
+

testdatax-0.1.0.dist-info/RECORD

@@ -0,0 +1,26 @@
+src/__init__.py,sha256=0bQUYmeNcWB-QTwPB464gAdohtIEnOqlbGZu6Cbl4QY,115
+src/cli.py,sha256=h4CffULDO56kH2FH7dmFRA9PkmNdPJZSqVdx28dmhLI,5992
+src/exporters/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+src/exporters/base_exporter.py,sha256=SQkavQTzent1htHbeUSYaB0SzHwtpuKAonjcIFgvw5c,618
+src/exporters/csv_exporter.py,sha256=_MnO4nwohO5aUPBnTnKSrPz2XnpF5r-rufffp7pWtK4,4436
+src/exporters/json_exporter.py,sha256=idi8eD64ZoYwuyn7aK4aNWKipEFzTaTabr6AL41bZ6I,3279
+src/exporters/mssql_exporter.py,sha256=te6-LL1tzkjwxMmLKBMJSiKug4nMK0iQCPGsEmbI9WQ,7388
+src/exporters/mysql_exporter.py,sha256=rJgHwlhkHeMTQ3Jc8gGnVP11BG80egwcCgxWD2WkSyc,6684
+src/exporters/oracle_exporter.py,sha256=KelLHKxySstM4aWVO6sG1DbJgfyDjvzO06gvwzzsM4w,7648
+src/exporters/orc_exporter.py,sha256=AKKEvM2OiGqglnh98HmNR7-VVdvCqGFxSP9duUYdEKQ,3372
+src/exporters/parquet_exporter.py,sha256=e0HvnP5K-SZ0voqZxQje0suySf3yuR4FlwAMSPbRpcs,3588
+src/exporters/utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+src/exporters/utils/chunker.py,sha256=4ORFh9SbbzJRKRxKcU3BmQg_TPbGz7WfdkNpcIiT-wI,935
+src/exporters/utils/constants.py,sha256=5kHau0F7j7dx0ekJP_BmRb5IAn_bkodBhYHsHhVG7KA,1759
+src/exporters/utils/exporter_config.py,sha256=ersV06RZY38LDWJ5Dbz2FHjUOA3LMvnSkAKIMjuKTXA,527
+src/exporters/utils/formatters.py,sha256=pZRp2sxCitopXK2fzKK5ZonKh1EaxlK21ZVeLAL_B44,4418
+src/generator.py,sha256=vxPY4xnAAdAtYxca1IDO8z4zPBG4aLxPzgUfpnD8Img,4451
+src/providers/__init__.py,sha256=2HM2EJZm_9yTI129E3dvi4Q_VH6rbTPE2oK5IdsMR8o,118
+src/providers/base.py,sha256=1zxmrE__UP61PmZF62hP3TYR7h_ECltQgv1D3vZ6zNg,1492
+src/providers/faker_provider.py,sha256=fOY2jSB6IaF9nLnITwUH414EgGRubzIXvs7EKrtbeLM,2314
+src/schemas.py,sha256=KZomIz__AjvJH8HOPIbInXzsC-5IYMcRYAyFSYjGQDI,2534
+testdatax-0.1.0.dist-info/LICENSE,sha256=hWMNYiI2moXwEsTtb1yeS8DLErzX-ORwz5_6YMbwuFo,1067
+testdatax-0.1.0.dist-info/METADATA,sha256=1izE3gMB5jnNSchqdZMePdbs-Ib0Jfmo9v36JGBumk4,7967
+testdatax-0.1.0.dist-info/WHEEL,sha256=IYZQI976HJqqOpQU6PHkJ8fb3tMNBFjg-Cn-pwAbaFM,88
+testdatax-0.1.0.dist-info/entry_points.txt,sha256=TeI36QYzNSfsZuK5pxrLwxDcKahnlteNdmvhQceg-6w,41
+testdatax-0.1.0.dist-info/RECORD,,

testdatax-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: poetry-core 2.0.1
+Root-Is-Purelib: true
+Tag: py3-none-any

testdatax-0.1.0.dist-info/entry_points.txt

@@ -0,0 +1,3 @@
+[console_scripts]
+testdatax=src.cli:app
+