https://github.com/cloudacademy/openai_storyteller

A Python-based web application used to demonstrate the OpenAI Assistants API
https://github.com/cloudacademy/openai_storyteller

Last synced: about 1 month ago
JSON representation

A Python-based web application used to demonstrate the OpenAI Assistants API

• Host: GitHub
• URL: https://github.com/cloudacademy/openai_storyteller
• Owner: cloudacademy
• Created: 2023-12-12T18:00:34.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2023-12-17T00:17:01.000Z (over 2 years ago)
• Last Synced: 2025-03-02T18:51:14.724Z (over 1 year ago)
• Language: Python
• Size: 789 KB
• Stars: 3
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# OpenAI Storyteller

This application demonstrates how to use the OpenAI Assistants API. The application is an interactive story creation tool. The intended use is as a choose your own adventure story creation tool. However, it's flexible enough to be used in other ways.

The application tracks the state of the story by capturing the theme, general story guidelines, and entities that appear in the story, such as: characters, items, and locations. The application ties into the OpenAI image and audio generation APIs to provide a more immersive experience. 

The user interface consists of a sidebar and a main view. The sidebar contains functionality for creating, loading, and removing story sessions. It also contains functionality for configuring the assistant and audio/image generation. The main view contains a chat input used to send messages to the assistant. Messages are displayed on the story tab of the main view. 

![The Story Tab](./screenshots/story.png)

Entities extracted from the story are displayed on the entities tab. The assistant uses the description of the entities to provide more context for the story, and to generate images.

![Entities Tab](./screenshots/entities.png)

### Requirements

- Python 3.11+

- OpenAI API key

### Setup

1. Clone the repository.

    ```bash

    git clone "https://github.com/cloudacademy/openai_storyteller.git"

2. Change directory to the root of the project.

    ```bash

    cd openai_storyteller

    ```

    

3. Create a new virtual environment.

    ```bash

    python -m venv .venv

    ```

4. Activate the virtual environment.

    ```bash

    source .venv/bin/activate

    ```

5. Change directory to the root of the project.

    ```bash

    cd stories

    ```

6. Install the dependencies.

    ```bash

    pip install -r requirements.txt

    ```

7. Create a `.env` file in the root of the project and add the following environment variables.

    ```bash

    echo "OPENAI_API_KEY=" > .env

    ```

8. Add the current module to the Python path.

    ```bash

    export PYTHONPATH=$PYTHONPATH:$(pwd)/src

    ```

9. Start the UI.

    ```bash

    streamlit run src/stories/ui.py

    ```

10. Open the URL listed in the console.