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.3.2.tar.gz (125.6 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.3.2-py3-none-any.whl (29.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: avro_datagen-0.3.2.tar.gz
  • Upload date:
  • Size: 125.6 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.3.2.tar.gz
Algorithm Hash digest
SHA256 351e7c19234e4d5c874ec7ebf8907093c31949556ddef4c55bf7d399443e3de8
MD5 005c23ac8d6211a6b58ebce2af392926
BLAKE2b-256 9f03a4b60eb9639a98d60edca73782f57a866ca69792ab250b59e4c1975b8a6e

See more details on using hashes here.

Provenance

The following attestation bundles were made for avro_datagen-0.3.2.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.3.2-py3-none-any.whl.

File metadata

  • Download URL: avro_datagen-0.3.2-py3-none-any.whl
  • Upload date:
  • Size: 29.4 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.3.2-py3-none-any.whl
Algorithm Hash digest
SHA256 ea28bd518c72cd946258b8e3db7ec3abf0f0b9b83a545d76c164d7eaf34868a3
MD5 669ac02b17e7c4cfe21468ea9dcf21a1
BLAKE2b-256 ea71681d2a65cfdedcd0a5f643bf2b0682682a566c403601f072bf5acbcfb9c9

See more details on using hashes here.

Provenance

The following attestation bundles were made for avro_datagen-0.3.2-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