loadforge 0.1.1__tar.gz

loadforge-0.1.1/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

loadforge-0.1.1/PKG-INFO

@@ -0,0 +1,453 @@
+Metadata-Version: 2.4
+Name: loadforge
+Version: 0.1.1
+Summary: Generate synthetic data from SQL DDL or live database schemas
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/hyangminj/datagen
+Project-URL: Repository, https://github.com/hyangminj/datagen
+Project-URL: Issues, https://github.com/hyangminj/datagen/issues
+Project-URL: Releases, https://github.com/hyangminj/datagen/releases
+Keywords: synthetic-data,sql,ddl,cli,faker
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Database
+Classifier: Topic :: Software Development :: Testing
+Classifier: Topic :: Utilities
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: sqlglot>=25.0.0
+Requires-Dist: Faker>=25.0.0
+Requires-Dist: SQLAlchemy>=2.0.0
+Requires-Dist: PyYAML>=6.0.0
+Requires-Dist: tomli>=2.0.1; python_version < "3.11"
+Provides-Extra: polars
+Requires-Dist: polars>=1.0.0; extra == "polars"
+Dynamic: license-file
+
+# loadforge
+
+Synthetic relational data generation for pipeline, staging, and service testing.
+
+- PyPI package: `loadforge`
+- CLI command: `datagen`
+- Python module: `datagen`
+
+`loadforge` turns SQL DDL or a live database schema into fake but structured data that is useful for load tests, end-to-end pipeline checks, local development, and staging environment seeding.
+
+It parses tables and foreign keys, generates rows in parent-before-child order, applies type-aware defaults plus optional distributions, validates the generated data, and writes it out as SQL, JSON, CSV, or Parquet. It can also insert directly into a database through SQLAlchemy.
+
+---
+
+## Why use it
+
+Use `loadforge` when you need to:
+
+- stress a pipeline or service with large synthetic datasets
+- generate relational fixtures from existing DDL
+- seed staging or local environments while preserving FK order
+- inspect a live schema and generate data without hand-writing metadata
+- export the same dataset shape in SQL, JSON, CSV, or Parquet
+- produce validation reports before loading data elsewhere
+
+---
+
+## Core capabilities
+
+- Input sources:
+  - SQL DDL via `--ddl`
+  - live schema introspection via `--schema-from-db --db-url ...`
+- Relationship-aware generation:
+  - foreign-key dependency graph
+  - parent tables generated before child tables
+  - FK-only tables can use the Polars generation path
+- Output formats:
+  - PostgreSQL `INSERT`
+  - MySQL `INSERT`
+  - SQLite `INSERT`
+  - BigQuery `INSERT` and `INSERT ALL`
+  - JSON
+  - CSV
+  - Parquet
+- Validation and reporting:
+  - FK integrity checks
+  - non-null checks
+  - unique collision checks
+  - optional CHECK validation with `--strict-checks`
+  - JSON report output via `--report-path`
+- Generation controls:
+  - per-table row overrides with `--table-rows`
+  - reproducible runs with `--seed`
+  - config-file driven runs with JSON, TOML, or YAML
+  - per-column and per-table distribution overrides with `--dist`
+
+---
+
+## Install
+
+Recommended for CLI use:
+
+```bash
+pipx install loadforge
+```
+
+Or install with `pip`:
+
+```bash
+pip install loadforge
+```
+
+Optional Polars support:
+
+```bash
+pip install "loadforge[polars]"
+```
+
+From source:
+
+```bash
+git clone https://github.com/hyangminj/datagen.git
+cd datagen
+python3 -m venv .venv
+. .venv/bin/activate
+pip install -e .
+```
+
+Optional Polars support from source:
+
+```bash
+pip install -e ".[polars]"
+```
+
+Sanity check:
+
+```bash
+datagen --help
+```
+
+GitHub Releases also include wheel (`.whl`) and source (`.tar.gz`) artifacts.
+
+---
+
+## Quick start
+
+Minimal schema:
+
+```sql
+CREATE TABLE users (
+  id INT PRIMARY KEY,
+  email VARCHAR(100) UNIQUE NOT NULL,
+  age INT,
+  tier VARCHAR(10)
+);
+
+CREATE TABLE orders (
+  id INT PRIMARY KEY,
+  user_id INT NOT NULL,
+  amount NUMERIC,
+  FOREIGN KEY (user_id) REFERENCES users(id)
+);
+```
+
+Generate JSON:
+
+```bash
+datagen --ddl schema.sql --rows 100 --out json --output-path data.json
+```
+
+Generate PostgreSQL inserts:
+
+```bash
+datagen --ddl schema.sql --rows 100 --out postgres --output-path seed.sql
+```
+
+Generate CSV files, one per table:
+
+```bash
+datagen --ddl schema.sql --rows 100 --out csv --output-path ./csv_out
+```
+
+With this schema, `users` is generated first and `orders.user_id` is filled from generated `users.id` values.
+
+---
+
+## Common workflows
+
+### Generate SQL for different targets
+
+```bash
+datagen --ddl schema.sql --rows 100 --out postgres
+datagen --ddl schema.sql --rows 100 --out mysql
+datagen --ddl schema.sql --rows 100 --out sqlite
+datagen --ddl schema.sql --rows 100 --out bigquery
+```
+
+### Read schema directly from a database
+
+```bash
+datagen \
+  --schema-from-db \
+  --db-url postgresql+psycopg://user:pass@localhost:5432/mydb \
+  --rows 100 \
+  --out postgres
+```
+
+Limit DB introspection to selected tables:
+
+```bash
+datagen \
+  --schema-from-db \
+  --db-url postgresql+psycopg://user:pass@localhost:5432/mydb \
+  --tables users,orders,events \
+  --rows 100 \
+  --out json
+```
+
+### Insert generated rows directly into a database
+
+```bash
+datagen \
+  --ddl schema.sql \
+  --rows 1000 \
+  --insert \
+  --db-url postgresql+psycopg://user:pass@localhost:5432/mydb
+```
+
+### Control row counts per table
+
+```bash
+datagen \
+  --ddl schema.sql \
+  --rows 100 \
+  --table-rows users=20,orders=500 \
+  --table-rows events=2000 \
+  --out json
+```
+
+- `--rows` stays the global default
+- `--table-rows table=count` overrides individual tables
+- config files can use a `table_rows` map
+
+### Generate a validation report
+
+```bash
+datagen \
+  --ddl schema.sql \
+  --rows 500 \
+  --strict-checks \
+  --report-path report.json \
+  --out json \
+  --output-path data.json
+```
+
+The report includes counts and sample issues for:
+
+- FK violations
+- non-null violations
+- unique collisions
+- supported CHECK violations when `--strict-checks` is enabled
+
+### Use Parquet or the Polars engine
+
+Parquet output:
+
+```bash
+datagen \
+  --ddl schema.sql \
+  --rows 100 \
+  --out parquet \
+  --parquet-compression zstd \
+  --output-path ./parquet_out
+```
+
+Polars generation and write path:
+
+```bash
+datagen \
+  --ddl schema.sql \
+  --rows 100000 \
+  --out csv \
+  --engine polars \
+  --output-path ./csv_out
+```
+
+Engine behavior:
+
+- tables with CHECK constraints fall back to the Python row-wise generator
+- tables with unique or primary-key constraints fall back to the Python row-wise generator
+- FK-only tables can remain on the Polars path
+- `--out parquet` requires the optional `polars` dependency regardless of `--engine`
+
+### BigQuery-specific output
+
+```bash
+datagen --ddl schema.sql --rows 100 --out bigquery --output-path out.sql
+datagen --ddl schema.sql --rows 100 --out bigquery --bq-insert-all --output-path out_insert_all.sql
+```
+
+BigQuery output supports:
+
+- dataset-qualified table names like `dataset.table`
+- `INSERT ALL` rendering via `--bq-insert-all`
+- typed `DATE` and `TIMESTAMP` literals
+
+---
+
+## Config file example
+
+```bash
+datagen --config datagen.toml
+```
+
+Example `datagen.toml`:
+
+```toml
+ddl = "schema.sql"
+rows = 500
+out = "postgres"
+seed = 42
+strict_checks = true
+table_rows = { users = 100, orders = 500, events = 2000 }
+dist = [
+  "users.age:normal,mean=33,std=7",
+  "orders.amount:pareto,alpha=1.7,xm=1",
+]
+```
+
+CLI arguments override config file values.
+
+---
+
+## Distribution overrides
+
+Syntax:
+
+```text
+--dist <column_or_table.column>:<kind>,k=v,k=v
+```
+
+Supported distribution kinds:
+
+- `normal`
+- `poisson`
+- `weighted`
+- `exponential`
+- `pareto`
+- `zipf`
+- `peak`
+
+Examples:
+
+```bash
+# global column rule
+--dist age:normal,mean=35,std=7
+
+# table-qualified rule (higher priority than global)
+--dist users.age:normal,mean=30,std=6
+
+# poisson counts
+--dist daily_orders:poisson,lambda=3
+
+# weighted categorical values
+--dist tier:weighted,A=60%,B=30%,C=10%
+
+# heavy-tail behavior
+--dist amount:pareto,alpha=1.5,xm=1
+--dist category_rank:zipf,skew=1.8,n=200
+
+# peak-hour timestamps
+--dist created_at:peak,hours=9-11,18-20
+```
+
+Priority when both exist:
+
+1. `table.column`
+2. `column`
+
+---
+
+## CHECK-aware generation
+
+`loadforge` uses practical heuristics for common CHECK constraints during generation and can optionally validate them again with `--strict-checks`.
+
+Supported forms include:
+
+- numeric comparison: `age >= 18`, `qty > 0`, `score <= 100`, `x != 0`
+- ranges: `price BETWEEN 10 AND 20`
+- enum lists: `status IN ('A', 'B', 'C')`
+- regex-like checks: `code ~ '^[A-Z]{2}$'`, `REGEXP_LIKE(code, '^[0-9]+$')`
+- nested compound forms built from supported expressions with `AND` and `OR`
+
+This is intentionally best-effort, not a full SQL expression engine.
+
+---
+
+## Reproducible runs
+
+Use `--seed` to stabilize Python random and Faker output:
+
+```bash
+datagen --ddl schema.sql --rows 100 --seed 42 --out json
+```
+
+---
+
+## CLI reference
+
+```bash
+datagen [--ddl schema.sql | --schema-from-db --db-url URL [--tables t1,t2]]
+        [--config config.toml]
+        [--rows 100]
+        [--table-rows users=20,orders=500] [--table-rows events=2000]
+        [--out postgres|mysql|sqlite|bigquery|json|csv|parquet]
+        [--engine python|polars]
+        [--bq-insert-all]
+        [--output-path PATH]
+        [--insert --db-url URL]
+        [--dist ...] [--dist ...]
+        [--seed INT]
+        [--report-path report.json]
+        [--strict-checks]
+        [--parquet-compression snappy|zstd|lz4|gzip|none]
+```
+
+Flag summary:
+
+- `--config`: load defaults from JSON, TOML, YAML, or YML
+- `--ddl`: input DDL file
+- `--schema-from-db`: inspect table metadata from a live database
+- `--tables`: optional comma-separated table filter for introspection mode
+- `--rows`: global default rows per table
+- `--table-rows`: per-table row overrides
+- `--out`: output format, default `postgres`
+- `--engine`: `python` or `polars`
+- `--bq-insert-all`: BigQuery `INSERT ALL ... SELECT 1;` mode
+- `--output-path`: output file path or output directory depending on format
+- `--db-url`: SQLAlchemy database URL for introspection or direct insert
+- `--insert`: insert generated rows directly into the target database
+- `--dist`: distribution overrides
+- `--seed`: deterministic generation seed
+- `--report-path`: write a JSON report with validation summary
+- `--strict-checks`: validate supported CHECK constraints after generation
+- `--parquet-compression`: Parquet compression codec
+
+---
+
+## Limitations
+
+- DDL parsing and DB introspection cover common schemas well, but advanced dialect-specific features are still partial.
+- CHECK-aware generation and `--strict-checks` cover a practical subset, not arbitrary SQL expressions.
+- Function-heavy or cross-column CHECK expressions are best-effort rather than fully modeled.
+- `--engine polars` still falls back to Python for tables with CHECK, unique, or primary-key constraints.
+
+---
+
+## License
+
+Apache License 2.0. See [LICENSE](LICENSE).