SYNOPSIZE

A minimal GUI which summarises text/audio or YT videos.

View Demo · Report Bug/Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Contributing
   • Architecture
   • Further Help
5. License
6. Contact
7. Acknowledgments

About The Project

Synopsize, is an audio/text summarizer. It app uses Google speech recognition and text-davinci-003 under the hood. The app also allows for Youtube Video summarization but only with transcripts.

(back to top)

Built With

(back to top)

Getting Started

To get a local copy up and running, just follow these simple steps.

Prerequisites

Make sure you have the following dependancies installed:

• Python (Preferably >= 3.6)
• ffmpeg (Follow the installation instructions based on your operating system)

Installation

1. Clone the repository:

   git clone https://github.com/AbhigyanBafna/Synopsize.git

2. Navigate to project root directory:

   cd Synopsize
   

3. Create and activate a virtual environment (optional but recommended):
   On Windows:

   python -m venv venv
   venv\Scripts\activate

   On macOS/Linux:

   python3 -m venv venv
   source venv/bin/activate

4. Install the Python dependencies using requirements.txt:

   pip install -r requirements.txt

5. Run the main script to start the application:

   python main.py
   

If you can see the application launch with a cool Splash Screen, 🎉 you have successfully set up Synopsize.

(back to top)

Usage

Synopsize could be used to summarize files like meetings, personal notes, transcripts, essays, letters, articles...the possibilities are endless.

There are multiple examples showcasing both, the input file and the output summary in samples

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated. However, please read this section carefully to understand the process and the project better.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project (Top right corner.)
2. Set it up locally (Refer to installation)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Open a Pull Request

Architecture

1. The Splash Screen renders a quick animation of our Logo using an Image Label.
2. The HomePage gives some timestamp and title options for the summary and diverges into 3 paths.
   1. Sum. Audio - Extracts text from audio file to convert into summary.
   2. Sum. Text - Extracts text from text file to convert into summary.
   3. Sum. Text - Extracts transcripts from YT video to convert into summary.
3. They converge at the openai.py where the summarization occurs.
4. The output is given to the formatter which formats the data into a standard bullet point format.

(back to top)

Further Help

You could watch this showcase of the app on Loom for better understanding.

If any further help is needed, do not hesitate to contact the author (Abhigyan Bafna) via . An issue can be raised as well.

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Feel free to contact me in case you want to connect/discuss something :)

• Twitter
• hello@abhigyan.tech
• LinkedIn

Project Link: https://github.com/AbhigyanBafna/Synopsize

(back to top)

Acknowledgments

Contributors -

• Altaf
• Sarah
• Amisha

Readme Boilerplate -

• Best-README-Template (Saved a LOT of time!)
• preview-markdown (Used this for editing this README.md as well)

(back to top)