ssai 1.0.10
SuperSummarizeAI is a versatile Python tool designed to extract and summarize textual content. Whether it's from a provided webpage URL, a YouTube video link, or a PDF file, this tool processes the content through ChatGPT to generate an insightful summary.

# SuperSummarizeAI

## Description
SuperSummarizeAI is a versatile Python tool designed to extract and summarize textual content. Whether it's from a provided webpage URL, a YouTube video link, or a PDF file, this tool processes the content through ChatGPT to generate an insightful summary. Once the summary is ready, the tool copies the content directly to your clipboard for quick access and sharing. Additionally, with its multilingual capabilities, SuperSummarizeAI can cater to a global audience, generating summaries in various languages.

## Installation

### Using pip (Recommended for all platforms)

1. Install SuperSummarizeAI using pip:
```
pip install ssai
```

2. Set your OpenAI key using the following command, replacing `YOUR_OPENAI_KEY` with your actual OpenAI key (You can get one [here](https://beta.openai.com/)):
```
ssai --OPENAI_KEY=YOUR_OPENAI_KEY
```

### Using Homebrew (macOS)

1. Tap into the SuperSummarizeAI repository:
```
brew tap alexandrevl/supersummarizeai
```
2. Install SuperSummarizeAI:
```
brew install ssai
```
3. Set your OpenAI key using the following command, replacing `YOUR_OPENAI_KEY` with your actual OpenAI key (You can get one [here](https://beta.openai.com/)):
```
ssai --OPENAI_KEY=YOUR_OPENAI_KEY
```

### Manual Installation

1. Ensure you have Python 3 installed on your system.
2. Clone the repository to your local machine:
```
git clone https://github.com/alexandrevl/SuperSummarizeAI.git
```
3. Navigate to the cloned directory:
```
cd SuperSummarizeAI
```
4. Install the required packages using pip:
```
pip install -r requirements.txt
```
5. Set your OpenAI key using the following command, replacing `YOUR_OPENAI_KEY` with your actual OpenAI key (You can get one [here](https://beta.openai.com/)):
```
python ssay.py --OPENAI_KEY=YOUR_OPENAI_KEY
```
For security reasons, always ensure that your `.env` file remains confidential. Do not share or expose it as it contains sensitive API credentials.

## Usage

### If Installed via pip or Homebrew:
Simply provide the desired URL (webpage or YouTube video) or PDF file as a command-line argument:

```
ssai <TARGET>
```

For instance:

```
ssai https://example.com
```
or 
```
ssai MY_PDF.pdf
```

For multilingual summaries, specify your desired language using the `--lang` option (default is 'brazilian portuguese'):
```
ssai <TARGET> --lang <desired_language>
```

For instance:
```
ssai https://example.com --lang english
```

For adding context to the AI, use the `--context` option:
```
ssai <TARGET> --context <context>
```

For instance:
```
ssai https://youtube.com/watch?v=example --context "The name of the presenter is John Doe"
```

For more information on the available options, run:
```
ssai --help
```

### If Installed Manually:
To employ SuperSummarizeAI, provide the desired URL (webpage or YouTube video) or PDF file as a command-line argument:

```
python ssay.py <TARGET>
```

For instance:
```
python ssay.py https://example.com
```
or 
```
python ssay.py MY_PDF.pdf
```

For multilingual summaries, specify your desired language using the `--lang` option (default is 'brazilian portuguese'):
```
python ssay.py <TARGET> --lang <desired_language>
```

For instance:
```
python ssay.py https://example.com --lang english
```

For give a context to the AI, use the `--context` option:
```
python ssay.py <TARGET> --context <context>
```

For instance:
```
python ssay.py https://youtube.com/watch?v=example --context "The name of presenter is John Doe"
```

For more information on the available options, run:
```
python ssay.py --help
```


## 📸 Examples

See SuperSummarizeAI in action:

### Webpage Summarization:
![Example of webpage summarization](./examples/example_website.png)

### YouTube Video Summarization:
![Example of YouTube video summarization](./examples/example_youtube.png)

## Troubleshooting

- **TARGET Input**: Make sure the URL you input is correctly formatted and always begins with `http://` or `https://`. For PDF files, ensure the file is in the same directory as the script or provide the full path to the file.
- **Dependencies**: Double-check to ensure all required dependencies are correctly installed. If you encounter any errors, try reinstalling the dependencies using `pip install -r requirements.txt`.
- **OpenAI Key**: Make sure your `.env` file contains the correct and valid OpenAI key.

## Contributing
Interested in contributing to SuperSummarizeAI? We'd love to collaborate! Please initiate by opening an issue to discuss the changes you'd like to make.

## License
Licensed under [MIT](https://choosealicense.com/licenses/mit/).