Metadata-Version: 2.5
Name: verisim
Version: 0.2.1
Summary: Context-aware synthetic data generation for coherent Pydantic domain models.
Project-URL: Homepage, https://github.com/Harshal96/verisim
Project-URL: Repository, https://github.com/Harshal96/verisim
Project-URL: Issues, https://github.com/Harshal96/verisim/issues
Author: Harshal Parekh
License-Expression: MIT
License-File: LICENSE
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Software Development :: Testing
Requires-Python: >=3.11
Requires-Dist: click<9,>=8.1
Requires-Dist: pydantic<3,>=2.7
Requires-Dist: typer<0.26,>=0.12
Provides-Extra: ai
Provides-Extra: dev
Requires-Dist: autoflake>=2.3; extra == 'dev'
Requires-Dist: black>=25.0; extra == 'dev'
Requires-Dist: coverage[toml]>=7.5; extra == 'dev'
Requires-Dist: django<6,>=4.2; extra == 'dev'
Requires-Dist: isort>=5.13; extra == 'dev'
Requires-Dist: pandas<3,>=2.2; extra == 'dev'
Requires-Dist: pytest>=8.0; extra == 'dev'
Requires-Dist: pyyaml<7,>=6; extra == 'dev'
Requires-Dist: ruff>=0.14; extra == 'dev'
Requires-Dist: sqlalchemy<3,>=2; extra == 'dev'
Provides-Extra: django
Requires-Dist: django<6,>=4.2; extra == 'django'
Provides-Extra: export
Requires-Dist: fastavro>=1.9; extra == 'export'
Requires-Dist: pyarrow>=16; extra == 'export'
Provides-Extra: fixtures
Requires-Dist: pyyaml<7,>=6; extra == 'fixtures'
Provides-Extra: full
Provides-Extra: kafka
Requires-Dist: confluent-kafka>=2.5; extra == 'kafka'
Provides-Extra: lite
Provides-Extra: masking
Requires-Dist: pandas<3,>=2.2; extra == 'masking'
Provides-Extra: pytest
Requires-Dist: pytest>=8.0; extra == 'pytest'
Provides-Extra: sqlalchemy
Requires-Dist: sqlalchemy<3,>=2; extra == 'sqlalchemy'
Description-Content-Type: text/markdown

# Verisim

Context-aware synthetic data for Python. The name comes from “verisimilitude,”
meaning “the appearance of being real.”

Verisim generates coherent Pydantic domain objects with shared context. A
person's name, username, email, address, job, company, and bio fit together,
making the data useful for demos, seed data, tests, and synthetic datasets.
Generation runs offline by default, supports reproducible seeds, and uses
non-routable synthetic contact details.

**Status:** early prototype (alpha). See the feature guides below for usage and
current limits.

## Install

Requires Python 3.11 or newer.

```bash
uv add verisim
# Or:
python -m pip install verisim
```

## Quickstart

```python
from verisim import PersonRecord, Verisim

record = Verisim(locale="en_US", seed=123).generate(PersonRecord)

print(record.person.name)
print(record.contact.email)
print(record.model_dump_json())
```

```bash
verisim person-record --seed 123
```

## Feature Guides

| Feature | README |
| --- | --- |
| Core models, context, related datasets, schema inference, statistical profiles, QA modes, CLI, and activity streams | [Core generation](src/verisim/README.md) |
| JSON/JSONL, CSV, SQL, SQLite, Parquet, Arrow, Avro, and schema contracts | [Exports](src/verisim/exporters/README.md) |
| Locale, script, lite/full data packs, and data provenance | [Data packs](src/verisim/datasets/README.md) |
| Coherent replacements for existing tabular PII | [Masking](src/verisim/masking/README.md) |
| SQLAlchemy, Django, and pytest factories and fixtures | [Framework integrations](src/verisim/integrations/README.md) |
| Offline instruction pairs, classification, NER, chat datasets, and custom adapters | [AI training](src/verisim/ai_training/README.md) |
| Measured API branch scenarios and replayable fixture bundles | [API fixtures](src/verisim/fixtures/README.md) |
| Runnable examples and a comparison with independent random fields | [Examples](examples/README.md) |

## Contributing

See [CONTRIBUTING.md](CONTRIBUTING.md) for source setup and local checks,
[CHANGELOG.md](CHANGELOG.md) for changes, and [RELEASING.md](RELEASING.md) for
release instructions.

## License

[MIT](LICENSE).
