Skip to content

FazlOmar9/Summariser

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Financial Document Summarizer

Overview

The Financial Document Summarizer is a Python-based tool that extracts text from a PDF file and generates a summarized version of its content. This is useful for quickly understanding key points in lengthy financial documents.

Features

  • Extracts text from financial PDFs.
  • Summarizes the extracted content for quick insights.
  • Simple and easy-to-use script.

Requirements

Ensure you have the following installed before running the script:

Installation

  1. Clone this repository:
    git clone https://github.com/your-username/financial-doc-summarizer.git
    cd financial-doc-summarizer
  2. Install dependencies:
    pip install -r requirements.txt

Usage

  1. Open main.py and set the document path in the following line:
    pages = extract_text_from_pdf("docs/reliance.pdf")
    Replace "docs/reliance.pdf" with the path to your financial document.
  2. Run the script:
    python main.py
  3. The summarized content will be displayed in the console or saved to an output file, depending on implementation.

File Structure

financial-doc-summarizer/
│── docs/
│   ├── reliance.pdf  # Sample financial document
│── main.py           # Main script to run the summarizer
│── inference.py     # Handles text summarization
│── reader.py      # Extracts text from PDFs
│── segment.py      # Segments extracted text into chunks
│── requirements.txt  # List of dependencies
│── README.md         # Project documentation

License

This project is licensed under the MIT License.

Contact

For any issues or suggestions, feel free to open an issue on GitHub or contact [fazlomr3@gmail.com].

About

Summarize financial docs in one go

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages