benchbox 0.1.0__tar.gz

benchbox-0.1.0/CHANGELOG.md

@@ -0,0 +1,60 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.1.0] - 2026-01-10 (Initial Release)
+
+> **Alpha Software**: BenchBox is alpha software. APIs may change without notice, features may be incomplete, and production use is not recommended. See [DISCLAIMER.md](DISCLAIMER.md) for full details.
+
+### Overview
+
+BenchBox v0.1.0 is the **initial public release** of the database benchmarking framework. BenchBox makes it simple to run industry-standard benchmarks (TPC-H, TPC-DS) on analytical databases, from embedded engines like DuckDB to cloud data warehouses like Snowflake and Databricks.
+
+### What's Included
+
+**Benchmarks** (18 total):
+- **TPC Standards**: TPC-H (22 queries), TPC-DS (99 queries), TPC-DI
+- **Academic**: SSB, AMPLab, JoinOrder (IMDB dataset)
+- **Industry**: ClickBench, H2ODB, NYC Taxi, TSBS DevOps, CoffeeShop
+- **Data Modeling**: TPC-H Data Vault
+- **BenchBox Primitives**: Read Primitives, Write Primitives, Transaction Primitives
+- **Experimental**: TPC-DS-OBT, TPC-Havoc, TPC-H Skew
+
+**SQL Platforms** (16 total):
+- **Embedded**: DuckDB, SQLite, DataFusion
+- **Cloud Data Warehouses**: Snowflake, Databricks, BigQuery, Redshift, Azure Synapse
+- **Analytical Databases**: ClickHouse, Trino, Presto, Firebolt, InfluxDB
+- **General Purpose**: PostgreSQL, Spark, Athena
+
+**DataFrame Platforms** (8 total):
+- **Expression Family**: Polars, DataFusion, DuckDB, PySpark
+- **Pandas Family**: Pandas, Modin, Dask, cuDF (GPU)
+
+**Core Features**:
+- Self-contained data generation (no external tools required)
+- Automatic SQL dialect translation between platforms
+- CLI with dry-run support, progress bars, and rich output
+- Programmatic Python API for integration
+- Result export in JSON, CSV, and HTML formats
+
+### Quick Start
+
+```bash
+# Install
+pip install benchbox
+
+# Run TPC-H on DuckDB
+benchbox run --platform duckdb --benchmark tpch --scale 0.01
+
+# Run with DataFrame API
+benchbox run --platform polars-df --benchmark tpch --scale 0.01
+```
+
+### Links
+
+- **Documentation**: [GitHub Repository](https://github.com/joeharris76/benchbox)
+- **Issues**: [Report bugs and request features](https://github.com/joeharris76/benchbox/issues)
+- **PyPI**: [pypi.org/project/benchbox](https://pypi.org/project/benchbox/)

benchbox-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Joe Harris / BenchBox Project
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

benchbox-0.1.0/MANIFEST.in

@@ -0,0 +1,34 @@
+include README.md
+include CHANGELOG.md
+include LICENSE
+include pyproject.toml
+include MANIFEST.in
+
+recursive-include benchbox *.py *.sql *.yaml *.json *.jinja2 *.md *.csv
+prune benchbox/platforms/clickhouse
+prune benchbox/platforms/bigquery
+prune benchbox/tpchavoc
+prune benchbox/primitives
+prune benchbox/tpcdi
+
+# Include TPC-DS query templates (required for query generation)
+recursive-include _sources/tpc-ds/query_templates *.tpl *.lst
+recursive-include _sources/tpc-ds/query_variants *.tpl
+
+# Include TPC-H query templates (required for query generation)
+recursive-include _sources/tpc-h/dbgen/queries *.sql
+recursive-include _sources/tpc-h/dbgen/variants *.sql
+
+# Include pre-compiled TPC binaries (required for data generation)
+# These are platform-specific executables for TPC-H and TPC-DS benchmarks
+# Binaries are included inside the benchbox package for proper installation
+recursive-include benchbox/_binaries/tpc-h *
+recursive-include benchbox/_binaries/tpc-ds *
+# Exclude macOS metadata files
+global-exclude .DS_Store
+
+prune tests
+prune docs
+prune examples
+
+global-exclude *.py[cod] __pycache__ *.so *.dylib *.dll *.log