Skip to content

Commit 9376323

Browse files
authored
Update Readme
Update README.md
2 parents e975f85 + 9bdab1a commit 9376323

File tree

1 file changed

+5
-40
lines changed

1 file changed

+5
-40
lines changed

README.md

Lines changed: 5 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -1,44 +1,9 @@
1-
# OpenAI API Quickstart - Python example app
1+
# AP Style Short Answer Question Generator and Grader Flask Application
22

3-
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.
3+
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.
44

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

7-
1. If you don’t have Python installed, [install it from here](https://www.python.org/downloads/).
7+
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.
88

9-
2. Clone this repository.
10-
11-
3. Navigate into the project directory:
12-
13-
```bash
14-
$ cd openai-quickstart-python
15-
```
16-
17-
4. Create a new virtual environment:
18-
19-
```bash
20-
$ python -m venv venv
21-
$ . venv/bin/activate
22-
```
23-
24-
5. Install the requirements:
25-
26-
```bash
27-
$ pip install -r requirements.txt
28-
```
29-
30-
6. Make a copy of the example environment variables file:
31-
32-
```bash
33-
$ cp .env.example .env
34-
```
35-
36-
7. Add your [API key](https://beta.openai.com/account/api-keys) to the newly created `.env` file.
37-
38-
8. Run the app:
39-
40-
```bash
41-
$ flask run
42-
```
43-
44-
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).
9+
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 commit comments

Comments
 (0)