Metadata-Version: 2.1
Name: snowfakery
Version: 2.5.1.dev0
Summary: Snowfakery is a tool for generating fake data that has relations between tables. Every row is faked data, but also unique and random, like a snowflake.
Home-page: https://github.com/SFDO-Tooling/Snowfakery
Author: Paul Prescod
Author-email: pprescod@salesforce.com
License: UNKNOWN
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.8
Description-Content-Type: text/markdown
Requires-Dist: certifi (==2021.10.8)
Requires-Dist: charset-normalizer (==2.0.11)
Requires-Dist: click (==8.0.3)
Requires-Dist: faker (==12.0.0)
Requires-Dist: greenlet (==1.1.2)
Requires-Dist: gvgen (==1.0)
Requires-Dist: idna (==3.3)
Requires-Dist: jinja2 (==2.11.3)
Requires-Dist: markupsafe (==2.0.1)
Requires-Dist: pydantic (==1.9.0)
Requires-Dist: python-baseconv (==1.2.2)
Requires-Dist: python-dateutil (==2.8.2)
Requires-Dist: pyyaml (==6.0)
Requires-Dist: requests (==2.27.1)
Requires-Dist: six (==1.16.0)
Requires-Dist: sqlalchemy (==1.4.31)
Requires-Dist: typing-extensions (==4.0.1)
Requires-Dist: urllib3 (==1.26.8)

[![Coverage Status](https://coveralls.io/repos/github/SFDO-Tooling/Snowfakery/badge.svg?branch=master)](https://coveralls.io/github/SFDO-Tooling/Snowfakery?branch=master)

# Snowfakery Documentation

Snowfakery is a tool for generating fake data that has relations between tables. Every row is faked data, but also unique and random, like a snowflake.

To tell Snowfakery what data you want to generate, you need to write a Recipe file in YAML.

Snowfakery can write its output to stdout, or any database accessible to SQLAlchemy. **When it is embedded in CumulusCI it can output to a Salesforce org**. Adding new output formats is fairly straightforward and open source contributions of that form are gratefully accepted.

[Documentation](https://snowfakery.readthedocs.io)

## Contributing

To contribute to snowfakery you will first need to setup a [virtual environment](https://docs.python.org/3/tutorial/venv.html).
Once you have youre virtual environment, you can install dependencies via pip:

`pip install -r requirements_dev.txt`

Or you can install dependencies via pip tools:

```python
make dev-install
```

Now you're all set for contributing to Snowfakery!

### Updating Dependencies

Performing dependency updates is easy. Just run `make update-deps` and commit any changes to `requirements/prod.txt` and `requirements/dev.txt`.


