Briefly.ai: Video to PDF Summarizer

Briefly.ai is a web application that takes a video file, transcribes the audio, summarizes the content, and provides a downloadable PDF of the summary.

Project Structure

The project is a Django application with the following structure:

.
├── .env
├── .gitignore
├── README.md
├── requirements.txt
├── db.sqlite3
├── manage.py
├── media
├── static
├── backend
│   ├── asgi.py
│   ├── settings.py
│   ├── urls.py
│   └── wsgi.py
└── uploader
    ├── admin.py
    ├── apps.py
    ├── convert.py
    ├── convert_wav.py
    ├── forms.py
    ├── models.py
    ├── templates
    │   ├── about.html
    │   └── upload.html
    └── urls.py

Getting Started

Prerequisites

• Python 3.8+
• pip

Setup

1. Clone the repository:

   git clone https://github.com/cbitosc/HTF24-Team-025.git
   cd HTF24-Team-025

2. Create and activate a virtual environment:

   python -m venv venv
   source venv/bin/activate  # On Windows, use `venv\Scripts\activate`

3. Install the dependencies:

   pip install -r requirements.txt

4. Download the SpaCy model:

   python -m spacy download en_core_web_md

5. Create the .env file:

   Create a .env file in the project root and add the following environment variables:

   SECRET_KEY='your-django-secret-key'
   SPEECH_SUBSCRIPTION_KEY='your-azure-speech-subscription-key'
   SPEECH_REGION='your-azure-speech-region'
   

   You can get the Django secret key from the original backend/settings.py file. The Azure Speech credentials can be obtained from your Azure account.

6. Run the database migrations:

   python manage.py migrate

Running the Application

To run the Django development server, execute the following command from the project root:

python manage.py runserver

The application will be available at http://127.0.0.1:8000/.

Contributing

We welcome contributions! Please follow these steps to contribute:

1. Fork the repository.
2. Create a new branch for your feature or bug fix.
3. Make your changes and commit them with a descriptive message.
4. Push your changes to your fork.
5. Create a pull request to the main branch of the original repository.

License

This project is licensed under the MIT License.