Metadata-Version: 2.4
Name: faux-db
Version: 0.1.1
Summary: Configuration-driven fake data generation built on top of faker.
Author-email: "Khoa, Le Minh" <leminkhoa@gmail.com>
Project-URL: Homepage, https://github.com/leminkhoa/faux-db
Project-URL: Repository, https://github.com/leminkhoa/faux-db
Project-URL: Documentation, https://leminkhoa.github.io/faux-db/
Requires-Python: >=3.11
Description-Content-Type: text/markdown
Requires-Dist: faker==40.11.0
Requires-Dist: pyyaml==6.0.3
Requires-Dist: pydantic==2.12.5
Requires-Dist: polars<=1.39.3
Requires-Dist: click
Requires-Dist: rich
Provides-Extra: pep8
Requires-Dist: ruff; extra == "pep8"
Provides-Extra: test
Requires-Dist: pytest>=9.0.2; extra == "test"
Requires-Dist: pytest-cov>=6.0.0; extra == "test"
Provides-Extra: docs
Requires-Dist: mkdocs==1.6.1; extra == "docs"
Requires-Dist: mkdocs-material; extra == "docs"
Requires-Dist: pymdown-extensions; extra == "docs"

# faux-db

`faux-db` is a configuration-driven fake data generation library that leverages the power of `faker` to create realistic datasets based on YAML definitions. It's designed with a strong emphasis on separation of concerns, allowing for highly modular and reusable data generation components.


## Features

- Declarative: define your data schemas in simple, human-readable YAML.
- Extensible: create custom data catalogs and provider logic for any domain.
- Separation of Concerns: keep table schemas, generation logic, and custom data neatly organized.
- Relationship Management: generate related rows across tables using `type: rel` (`$rel`) and column references.

## Full Documentation

See: https://leminkhoa.github.io/faux-db/

## Install

```bash
pip install faux-db
```

## Quickstart

```bash
faux init
faux schema generate schemas/products.yml
```

## Contributing

Contributions are welcome. Please open an issue or submit a pull request.

## License

This project is licensed under the MIT License.
