Metadata-Version: 2.1
Name: openfaker
Version: 0.0.1
Summary: Generate fake data with OpenAI's GPT-3 API.
Home-page: https://github.com/zh-plus/faker-openai
Author: Hao Zheng
Author-email: zhenghaosustc@gmail.com
License: MIT
Keywords: openai-gpt3,fake-data,data generation
Classifier: Programming Language :: Python :: 3
Classifier: Intended Audience :: Developers
Classifier: Topic :: Scientific/Engineering
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3.11
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: openai
Requires-Dist: pycountry

# OpenFaker

*OpenFaker* is a Python package that utilizes OpenAI's GPT series model to generate fake data.

**This new project is rapidly underway, and we welcome any issues or pull requests.**

## Basic Usage

Install with pip:

```shell
pip install openfaker
```

Use `faker.Faker()` to create and initialize a faker generator, which can generate data by accessing properties named
after the type of data you want.

```python
from openfaker import Faker
from openfaker.utils import setup_openai

setup_openai('<api-key>')  # Get your API key from https://platform.openai.com/account/api-keys

faker = Faker()
faker.name()
# 'John Doe'

faker.address(2)
# ['426 Jordy Lodge', 'Cartwrightshire, SC 88120-6700']
```
