BookBrief | Devpost

Inspiration

As a math major, I often struggle to comprehend dense pure math textbooks. It sometimes takes multiple readings of the same proof to grasp the underlying concepts. To simplify this process, I started writing out the content in LaTeX and feeding it through ChatGPT to gain a high-level understanding of the material before diving into the intricacies of the proofs. However, this was a tedious and time-consuming process since ChatGPT could not access specific pages and summarize them for me. This experience led me to create BookBrief, a web-based app that uses GPT to summarize technical books and make them easier to understand. The inspiration behind BookBrief stems from the challenges that students face while trying to comprehend complex coursework.

What it does

BookBrief is designed to help students, professionals, and anyone seeking to learn technical topics from books quickly and efficiently. With BookBrief, all you need to do is upload the PDF of the book and select the pages you want to summarize, whether it's a single page or a range of pages. BookBrief then generates a summary of the selected content, making it easier for users to quickly understand the key concepts and ideas presented in the book.

How we built it

First, I wrote the prompt and created a function to access the OpenAI API. Next, I developed a function to parse the uploaded PDF and generate summaries of the pages. To bring the application to life, I implemented it using the Python Django framework and utilized an XML HTTP Request object to send data to the server when the user hits submit. Upon receiving the data, Django executes the necessary functions to extract the summary, which is then returned to the client and displayed.

Challenges we ran into

During the project, we faced challenges in debugging errors, processing and parsing the PDF files, and deploying the application. To resolve any issues with errors and bugs, we used debugging tools and techniques such as console logs, breakpoints, and error messages to identify and fix the issues. For data processing and parsing, we encountered issues with formatting and missing data, which we addressed by implementing validation checks and error handling mechanisms. Finally, for deployment and hosting, we faced challenges related to scaling and availability, which we managed by using cloud services and hosting platforms that provide scalable and reliable infrastructure.

Accomplishments that we're proud of

We're proud of several accomplishments throughout this project. Firstly, we learned some cool and useful things, such as how to access the OpenAI API and how to use Django to create a functional website. Additionally, we were able to automate a utility that we needed and construct a website to showcase it. This included setting up the Django workspace and writing the necessary code for views, models, and urls. Overall, we're proud of the work we've done and the skills we've developed throughout the project.

What we learned

Throughout the process of building this application, I encountered a number of challenges and obstacles that pushed me to learn and grow as a developer. One of the biggest challenges was debugging errors and bugs that arose during the development process. However, I was able to overcome these issues through careful examination of the code and utilizing debugging tools to identify and resolve the issues.

Another challenge was processing and parsing the PDF files to extract the relevant content. I had to be meticulous in my approach to ensure that all necessary data was being captured and formatted correctly. Through trial and error, I was able to refine my methods and develop a more streamlined process for extracting data from PDF files.

Overall, building this application allowed me to develop my technical skills in areas such as Django, API integration, and data processing and gained valuable experience in project management, which will serve me well in future endeavors.

What's next for BookBrief

Looking ahead, BookBrief has many exciting opportunities for growth and development. One potential direction is to integrate machine learning algorithms to enhance the accuracy of the summaries. Furthermore, there are plans to expand the functionality of the application beyond just PDF files, to include other document formats such as Word files or webpages. Improving the user interface and experience is also a priority to make the application more accessible and user-friendly. With endless possibilities, the team is dedicated to determining the best path forward for BookBrief.