mark-wiemer / hello-openai

My first project with the OpenAI API (Python)

OpenAI API Quickstart - Python example app

This is an example pet name generator app used in the OpenAI API quickstart tutorial. It uses the Flask web framework. Check out the tutorial or follow the instructions below to get set up.

Setup

1. If you don’t have Python installed, install it from here.

2. Clone this repository.

3. Navigate into the project directory:

   $ cd openai-quickstart-python

4. Create a new virtual environment:

   $ python -m venv venv
   $ . venv/bin/activate

5. Install the requirements:

   $ pip install -r requirements.txt

6. Make a copy of the example environment variables file:

   $ cp .env.example .env

7. Add your API key to the newly created .env file.

8. Run the app:

   $ flask run

You should now be able to access the app at http://localhost:5000! For the full context behind this example app, check out the tutorial.

Troubleshooting

If flask run results in command not found, re-read the warnings during installation of the requirements and ensure the folder containing flask.exe is in your PATH.