Skip to content

Commit

Permalink
Update Readme
Browse files Browse the repository at this point in the history
Update README.md
  • Loading branch information
maxspier authored May 19, 2024
2 parents e975f85 + 9bdab1a commit 9376323
Showing 1 changed file with 5 additions and 40 deletions.
45 changes: 5 additions & 40 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,44 +1,9 @@
# OpenAI API Quickstart - Python example app
# AP Style Short Answer Question Generator and Grader Flask Application

This is an example pet name generator app used in the OpenAI API [quickstart tutorial](https://beta.openai.com/docs/quickstart). It uses the [Flask](https://flask.palletsprojects.com/en/2.0.x/) web framework. Check out the tutorial or follow the instructions below to get set up.
This application is designed to allow students to generate AP Style Short Answer Questions, answer them, and have AI grade them. The application provides students with a sample response.

## Setup
This application is by all means a work in progress. New features are added rapidly and frequently.

1. If you don’t have Python installed, [install it from here](https://www.python.org/downloads/).
This application was developed in part with the OpenAI API quickstart guide for easy use of the OpenAI API. Some images or fonts have been borrowed from this quickstart guide. All other program code, however, is mine.

2. Clone this repository.

3. Navigate into the project directory:

```bash
$ cd openai-quickstart-python
```

4. Create a new virtual environment:

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

5. Install the requirements:

```bash
$ pip install -r requirements.txt
```

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

```bash
$ cp .env.example .env
```

7. Add your [API key](https://beta.openai.com/account/api-keys) to the newly created `.env` file.

8. Run the app:

```bash
$ flask run
```

You should now be able to access the app at [http://localhost:5000](http://localhost:5000)! For the full context behind this example app, check out the [tutorial](https://beta.openai.com/docs/quickstart).
The identifier "AP" is a registered trademark of CollegeBoard. This application is not affiliated with CollegeBoard in any means, and does not recieve monetary payment from CollegeBoard.

0 comments on commit 9376323

Please sign in to comment.