This repository provides a Streamlit application that leverages OpenAI to extract key points from research papers uploaded in PDF format.
- Upload a PDF research paper.
- Enter a question about the paper (e.g., key points).
- Get a summary of the key points based on the query and AI analysis.
- User-friendly interface with clear instructions and error handling.
-
Clone this repository:
git clone [https://github.com/](https://github.com/)<your-username>/chat-with-pdf.git
2. Install required libraries:
Bash
pip install streamlit pypdf2 langchain openai
## Usage
1. Navigate to the project directory:
Bash
cd chat-with-pdf
2. Run the Streamlit app:
Bash
streamlit run pdf_summarizer.py
3. The app will open in your web browser, typically at `http://localhost:8501`.
## Configuration
* **OpenAI API Key:**
* You need an OpenAI API key to use the application's AI capabilities.
* Obtain a key from https://openai.com/ and set the environment variable `OPENAI_API_KEY` within the Streamlit app. **Important:** Never share your API key publicly. Consider storing it securely using environment variables.
## Contributing
We welcome contributions to improve this project! Please see the CONTRIBUTING.md file (if included) for guidelines.
## License
This project is licensed under the MIT License (see LICENSE.md for details).
Explanation:
- The README provides a clear overview of the application's purpose and features.
- It outlines the installation steps and usage instructions.
- It emphasizes the importance of obtaining and securely storing your OpenAI API key.
- It encourages contributions and provides information on licensing.
Additional Tips:
- You can add screenshots or GIFs demonstrating the application's functionality.
- Consider including links to relevant documentation or tutorials on Streamlit and OpenAI.
- If you have a specific coding style guide, follow it within your code and README.
By incorporating this well-structured and informative README, you'll enhance your project's visibility and usability on GitHub.