Skip to content

Latest commit

 

History

History
182 lines (106 loc) · 5.4 KB

README.md

File metadata and controls

182 lines (106 loc) · 5.4 KB

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. Overall, a dumping ground of experiments and code for the Climate Tech Handbook Website.


Current Goals

1. API Development
  • Expand the API to handle HTTP requests, allowing users to interact with the content generation features using tools like Postman, Thunder Client, etc.
  • Implement various API endpoints for different content generation operations, such as creating, updating, and deleting content.
2. CLI Commands
  • Develop CLI commands to create content locally while the Flask app is running, providing a more convenient way to interact with the content generation features.
3. Error Handling
  • Implement robust error handling throughout the application to provide helpful feedback to users and ensure the stability of the system.
4. Advanced File Editing
  • Add advanced file editing capabilities, such as inserting, replacing, and removing content from existing files and directories.
5. Improved Prompts
  • Design better prompts for content generation to enhance the quality and relevance of the generated content.
6. Enhanced Templates
  • Create more sophisticated templates for various content types and use cases, providing users with greater flexibility in customizing their generated content.
7. Unsplash Integration
  • Integrate Unsplash functionality into the templates, allowing users to include relevant images in their generated content.

Future Plans

1. Integration of Additional OpenAI Services
  • Integrate more of OpenAI's services into the tool, such as DALL-E, Whisper, Fine-Tuning, etc., to create even more advanced tooling and markdown content.
2. RSS Bridge for Climate Data Fine-Tuning
  • Develop a unique RSS bridge to collect and process climate data, which will be used for fine-tuning the AI model and enhancing the quality and relevance of the generated content.
3. Climate Tech Chatbot
  • 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.

Using Flask App

Installation

1. Clone this repository to your local machine.
git clone [email protected]:climate-tech-handbook/data-magic.git
2. Change working directory to data-magic/app/
cd data-magic/app/
3. Create a virtual environment.

Python 3.4 or above:

python -m venv venv

otherwise you can use:

pip install virtualenv
virtualenv venv
3. Activate virtual environment.

Linux or MacOS:

source venv/bin/activate

Windows (cmd.exe):

venv\Scripts\activate.bat

Windows (Powershell):

venv\Scripts\Activate.ps1
4. Install the required packages.
pip install -r requirements.txt

Setting up .env (API Keys)

Ensure you are still in the data-magic/app/ directory

To use the content generator, you will need an OpenAI API key:

1. Obtain your OpenAI API key from the OpenAI Dashboard.
2. Create a .env file in the root directory of your project (if it does not yet already exist)
3. Add your OpenAI API key to the .env file in the following format:
OPENAI_SECRET_KEY=your_api_key_here

Replace your_api_key_here with the actual key you obtained from OpenAI.

We use Unsplash Photos as our stock image provider:

UNSPLASH_ACCESS_KEY=your_api_key_here
4. In your Python code, you can use the dotenv library to load API keys from the .env file:
from dotenv import load_dotenv
import os

load_dotenv()
api_key = os.getenv("ENVIRONMENT_VAR_NAME")

Running the Flask App

If you completed the installation process without any persisting errors, you can continue. If you need further assistance, open an issue.

1. Run the Flask app with flask run or try python app.py
2. The app will create a file for a specific topic using the prompts, templates, and configurations provided in the data folder.
  • At this moment in the app it's being forced with a @before_request decorator, this will be improved upon in the future.
3. The generated file will be saved in the output_test folder.

Contributing

Contributions are welcome! Please feel free to submit issues, feature requests, or pull requests.

If you are lost on how to start contributing or don't understand how a certain class or file works, try checking out our Contributing Guide


License

This project is licensed under the MIT License. See the LICENSE file for more details.

This README provides an overview of the project, installation instructions, usage examples, and contribution guidelines. You can customize the content as needed to better suit your project.


Acknowledgments

This project is in active development and is currently in an MVP stage, stay tuned to see how it grows!