From aa876d7428b1dbcac72eb6622e9beee71b52e267 Mon Sep 17 00:00:00 2001 From: Aidan Loughney <36386493+ArLough@users.noreply.github.com> Date: Sun, 11 Jun 2023 16:48:38 -0400 Subject: [PATCH] Update README.md - reorganization Minor reorganization and clarification on how to get started with the installation of the Flask app --- README.md | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 609ac5f2..047c6b81 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Data Magic (OpenAI Utility API) -This project provides an API for generating content using OpenAI's completion models. It includes a `ContentGenerator` class, utility functions, and a simple Flask app to generate content based on prompts, templates, and other configurations. +This project provides an API for generating content using OpenAI's completion models. It includes a `ContentGenerator` class, utility functions, and a simple Flask app to generate content based on prompts, templates, and other configurations. Overall, a dumping ground of experiments and code for the Climate Tech Handbook Website. ## Current Goals @@ -47,13 +47,16 @@ This project provides an API for generating content using OpenAI's completion mo - Use the resource database and RSS bridge, along with fine-tuning, to create the "Climate Tech Chatbot," a tool designed to provide users with valuable insights and information on climate technologies and trends. -## Installation +## Using Flask App + +### Installation 1. Clone this repository to your local machine. -2. Create a virtual environment and activate it. -3. Install the required packages using `pip install -r requirements.txt`. +2. Cd into /app +3. [Create](https://python.land/virtual-environments/virtualenv#How_to_create_a_Python_venv) a virtual environment and [activate it](https://python.land/virtual-environments/virtualenv#Python_venv_activation). +4. Install the required packages using `pip install -r requirements.txt`. -## Setting and Using the OpenAI API Key +### Setting and Using the OpenAI API Key To use the generator, you will need an OpenAI API key. Follow these steps to set and use the `OPENAI_SECRET_KEY`: