Metadata-Version: 2.4
Name: OpenAIChatHelper
Version: 0.1.1.1
Summary: A helper package for OpenAI API
Project-URL: Homepage, https://github.com/<you>/<repo>
Project-URL: Issues, https://github.com/<you>/<repo>/issues
Author-email: Yining Hong <yhong3@andrew.cmu.edu>
License: MIT
License-File: LICENSE
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.8
Requires-Dist: markdown-it-py>=3.0.0
Requires-Dist: mdformat>=0.7.0
Requires-Dist: openai>=1.0.0
Description-Content-Type: text/markdown

# OpenAIChatHelper

Getting annoyed at managing complicated and long prompts and doing substitutions. So creating this helper to make things easier.

## 🚀 Installation

### 1. Set up your API key

Get your OpenAI API key from [OpenAI API Keys](https://platform.openai.com/settings/organization/api-keys).

Then, export it as an environment variable:

```bash
export OPENAI_API_KEY="YOUR_API_KEY_HERE"
```

To make this persistent, add the above line to your shell configuration file (`~/.bashrc`, `~/.zshrc`, etc.).


### 2. Install the package

From [PyPI](https://pypi.org/project/OpenAIChatHelper/):

```bash
pip install OpenAIChatHelper
```

Or, to install locally from source:

```bash
pip install ./
```

## 💡 Usage

Check out the example script:

```bash
python example_usage.py
```
