Extract-Possible-Titles-from-Sentence

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Contributing
4. Contact
5. Acknowledgements

About The Project

The repository aimed at providing user a functionality of extracting the possible titles from the mentioned sentence. Currently the update is supporting two languages : Hebrew and English.

In near future, it will be made available for different langauges.

Built With

Here are the major frameworks that were used to build this project.

• Python
• Spacy
• Flask

Getting Started

The following are the steps for your smooth usage of this repository. Please follow the below instructions to reach to the final response output.

Prerequisites

Install all the necessary packages and libraries through

• pip3/ pip

  pip3 install -r requirements.txt 
  

Installation

1. Clone the existing repository on your local machine.
2. Dive to the folder path.
3. Run the requirements.txt file to download all the necessary libraries and packages using pip3 install -r requirements.txt
4. Run the main file using python3 main.py
5. Open the Postman to check the responses. Place {"text":"sentence xyz"} in your Raw-> Json input. Also mention {localhost}/getTitles/ as the request URL. Hit Send.

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your own Feature Branch (git checkout -b feature/NewFeature)
3. Commit your Changes (git commit -m 'Add some NewFeature')
4. Push to the Branch (git push origin feature/NewFeature)
5. Open a Pull Request

Contact

Name - Mimansha Goyal - mimansha02@gmail.com Project Link: https://github.com/mish1102/Extract-Possible-Titles-from-Sentence