Skip to main content

Schema-driven fake data generator for Avro schemas with arg.properties hints

Project description

📝 avro-datagen

CI PyPI version License: MIT Python 3.13+ Docs

Schema-driven fake data generator for Avro schemas. Reads .avsc files with arg.properties hints and produces realistic records. Includes Faker for names, emails, addresses, and more.

avro-datagen generates data -- nothing more. Pipe JSON output to Kafka, databases, files, or any other sink using the tools you already have.

Install

pip install avro-datagen                 # CLI + library + Faker
pip install "avro-datagen[ui]"           # + Streamlit web UI
pip install "avro-datagen[app]"          # + UI + Kafka producer (for interactive testing)

Web UI

pip install "avro-datagen[ui]"
avro-datagen ui

Opens a Streamlit dashboard at localhost:8501 with a bundled example schema. Browse schemas, edit them live, preview generated data, and download samples.

The UI creates a schemas/ folder in your working directory when you save a schema. Point --schema-dir at an existing folder to use your own schemas.

avro-datagen ui --schema-dir ./my-schemas      # use your own schemas
avro-datagen ui --port 3000                    # custom port
avro-datagen ui --kafka                        # enable Kafka producer section

CLI

# Create a schema file
cat > order.avsc << 'EOF'
{
  "type": "record",
  "name": "Order",
  "fields": [
    { "name": "id", "type": { "type": "string", "logicalType": "uuid" } },
    { "name": "amount", "type": "double", "arg.properties": { "range": { "min": 5, "max": 500 } } },
    { "name": "customer", "type": "string", "arg.properties": { "faker": "name" } }
  ]
}
EOF

# Generate 10 records
avro-datagen -s order.avsc

# Pretty-print, seeded for reproducibility
avro-datagen -s order.avsc -c 5 --seed 42 --pretty

# Rate-limited, infinite
avro-datagen -s order.avsc -c 0 --rate 10

Library

from avro_datagen import generate

for record in generate("order.avsc", count=100):
    print(record)

# Deterministic output
records = list(generate("order.avsc", count=10, seed=42))

Sinks and integrations

avro-datagen does not bundle integrations for databases, cloud storage, or message queues. The CLI emits JSON lines to stdout -- pipe it anywhere:

avro-datagen -s schema.avsc -c 1000 | kcat -b localhost:9092 -t topic   # Kafka
avro-datagen -s schema.avsc -c 1000 > data.jsonl                        # File
avro-datagen -s schema.avsc -c 1000 | psql -c "COPY t FROM STDIN"       # Postgres

The Kafka producer in the UI (--kafka) is a convenience for interactive testing, not a production integration.

Development

git clone https://github.com/ConsciousExplorer/avro-datagen.git
cd avro-datagen

With uv (recommended):

uv sync --all-extras

make test       # run tests
make check      # lint + typecheck + tests
make app        # streamlit UI
make docs       # mkdocs dev server

With pip:

python3 -m venv .venv && source .venv/bin/activate
pip3 install -e ".[dev,ui]"
make test

Documentation

Full documentation: consciousexplorer.github.io/avro-datagen

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

avro_datagen-0.2.7.tar.gz (106.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

avro_datagen-0.2.7-py3-none-any.whl (21.9 kB view details)

Uploaded Python 3

File details

Details for the file avro_datagen-0.2.7.tar.gz.

File metadata

  • Download URL: avro_datagen-0.2.7.tar.gz
  • Upload date:
  • Size: 106.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for avro_datagen-0.2.7.tar.gz
Algorithm Hash digest
SHA256 ef5988540fe76984b3295cc5ca3f1c9b8233a88a14fdb53faaf9940508b5c309
MD5 5244c2a918b9db6e44fae69043fe85c4
BLAKE2b-256 fb7203b1e09e90340b7f933a507eef4eb9e6803f85f36123d527ed813f0685df

See more details on using hashes here.

Provenance

The following attestation bundles were made for avro_datagen-0.2.7.tar.gz:

Publisher: publish.yml on ConsciousExplorer/avro-datagen

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file avro_datagen-0.2.7-py3-none-any.whl.

File metadata

  • Download URL: avro_datagen-0.2.7-py3-none-any.whl
  • Upload date:
  • Size: 21.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for avro_datagen-0.2.7-py3-none-any.whl
Algorithm Hash digest
SHA256 1d522daed3a80828807cda7c457e7a44d4a3ece65cf0b0f1665e976ab9071c3b
MD5 b699d9e5fbfcd111c183087666f4b816
BLAKE2b-256 fe1470788c6a79acd75631fc7d5da0fd83903936a0fc5947210155cc9212c45a

See more details on using hashes here.

Provenance

The following attestation bundles were made for avro_datagen-0.2.7-py3-none-any.whl:

Publisher: publish.yml on ConsciousExplorer/avro-datagen

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page