Shakespeare-AI / README.md
danielrosehill's picture
Fix deprecated parameter and update image reference
a1db8bc unverified
---
title: Shakespeare AI
emoji: 😻
colorFrom: yellow
colorTo: gray
sdk: streamlit
sdk_version: 1.44.1
app_file: app.py
pinned: false
license: cc-by-nc-sa-4.0
short_description: Rewrites .. stuff .. in Shakespearean English
---
![Shakespeare GPT](shakespearegpt.png)
A Streamlit application that transforms modern text into Shakespearean English using various system prompts.
## Features
- Transform any text into Shakespearean English
- Multiple transformation styles for different types of content
- Easy-to-use interface with input and output areas
- Copy and clear functionality for convenience
- Secure API key input
## Usage
1. Run the Streamlit application:
```
streamlit run app.py
```
2. Open your web browser and navigate to the URL displayed in the terminal (usually http://localhost:8501)
3. Enter your OpenAI API key in the sidebar
4. Select a transformation style from the dropdown menu
5. Enter your text in the input area
6. Click the "Transform to Shakespearean" button
7. View the transformed text in the output area
8. Use the "Copy Text" button to copy the transformed text to your clipboard
9. Use the "Clear Text" button to clear the output
## System Prompts
The application uses a collection of system prompts organized in the `system-prompts` directory. These prompts are designed to transform different types of content into Shakespearean English, including:
- Basic transformations
- Business tools
- Various formats (emails, social media posts, etc.)
- Different purposes (documentation, copywriting, etc.)
Each prompt provides specific instructions for transforming text in a way that's appropriate for the content type.
## Requirements
- Python 3.7+
- Streamlit
- OpenAI API key
## Note
This application requires an OpenAI API key to function. You can obtain an API key by signing up at [OpenAI's website](https://platform.openai.com/signup).