Metadata-Version: 2.1
Name: jafgen
Version: 0.3.1
Home-page: https://github.com/dbt-labs/jaffle-shop-generator
Author: dbt Labs™️
Author-email: winnie@dbtlabs.com
License: Apache
Classifier: Intended Audience :: Science/Research
Classifier: Development Status :: 3 - Alpha
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy (==1.24.0)
Requires-Dist: pandas (==1.5.2)
Requires-Dist: Faker (==15.3.4)
Requires-Dist: tqdm (==4.64.1)
Provides-Extra: dev
Requires-Dist: flake8 ; extra == 'dev'
Requires-Dist: mypy (==0.991) ; extra == 'dev'
Requires-Dist: black (==22.12.0) ; extra == 'dev'
Requires-Dist: isort (==5.11.4) ; extra == 'dev'
Requires-Dist: pytest ; extra == 'dev'
Requires-Dist: pytest-sphinx ; extra == 'dev'
Requires-Dist: pytest-cov ; extra == 'dev'
Requires-Dist: twine (>=1.11.0) ; extra == 'dev'
Requires-Dist: setuptools ; extra == 'dev'
Requires-Dist: wheel ; extra == 'dev'
Requires-Dist: Sphinx (<5.4.0,>=4.3.0) ; extra == 'dev'
Requires-Dist: furo (==2022.12.7) ; extra == 'dev'
Requires-Dist: myst-parser (<0.19.0,>=0.15.2) ; extra == 'dev'
Requires-Dist: sphinx-copybutton (==0.5.1) ; extra == 'dev'
Requires-Dist: sphinx-autobuild (==2021.3.14) ; extra == 'dev'
Requires-Dist: sphinx-autodoc-typehints ; extra == 'dev'
Requires-Dist: packaging ; extra == 'dev'

# 🥪 Jaffle Shop Generator 🏭

The Jaffle Shop Generator or `jafgen` is a python package with a simple command line tool for generating a synthetic data set suitable for analytics engineering practice or demonstrations.

## Installation

```shell
pip install jafgen
```

## Use

`jafgen` takes one argument, years, which sets the length of time the simulation generates synthetic data for.

```shell
# generate a simulation spanning 3 years from 2016-2019
jafgen --years 3
```

## Purpose

Finding a good data set to practice, learn, or teach analytics engineering with can be difficult. Most open datasets are great for machine learning -- they offer single wide tables that you can manipulate and analyze. Full, real relational databases on the other hand are generally protected by private companies. Not only that, but they're a bit _too_ real. To get to a state that a beginner or intermediate person can understand, there needs to be an advanced amount of analytics engineering transformation applied.

## Approach

Coming soon.

## Contribution

Coming soon.
