Skip to content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

📚 PaperSage

Python API License Status

PaperSage is a Python-based research paper explorer that integrates with the arXiv API to simplify academic literature discovery. It enables users to search research papers by keyword, author, or title, filter results by publication period, sort papers by relevance or newest first, export search results as a Markdown report, and download research paper PDFs directly from the command line.


✨ Features

  • 🔍 Search research papers by:

    • Keyword
    • Author
    • Title
  • 📅 Filter papers by publication period:

    • Last 3 Years
    • Last 5 Years
    • Last 10 Years
    • All Papers
  • 📊 Sort search results by:

    • Relevance
    • Newest First
  • 📄 Export search results as a well-formatted Markdown report

  • 📥 Download:

    • All research paper PDFs
    • Selected paper PDFs
  • 📝 Display paper information including:

    • Title
    • Authors
    • Publication Date
    • Abstract
    • Paper URL
    • PDF URL
  • ⚠️ Gracefully handles:

    • Invalid user input
    • API errors
    • Missing or unavailable PDF links

🛠️ Tech Stack

  • Python 3.11
  • arXiv API
  • arxiv Python Library
  • Requests
  • Markdown
  • Git & GitHub
  • Visual Studio Code

📂 Project Structure

PaperSage
│
├── images/
│   ├── search_demo.png
│   ├── markdown_output.png
│   └── pdf_download.png
│
├── output/
│   └── results.md
│
├── papers/
│
├── src/
│   ├── app.py
│   ├── arxiv_client.py
│   ├── markdown_writer.py
│   └── pdf_downloader.py
│
├── README.md
├── requirements.txt
├── LICENSE
└── .gitignore

🚀 Installation

Clone the repository.

git clone https://github.com/devikabraj08-ai/PaperSage.git

Move into the project directory.

cd PaperSage

Create a virtual environment.

python -m venv venv

Activate the virtual environment.

Windows

venv\Scripts\activate

Linux / macOS

source venv/bin/activate

Install the required dependencies.

pip install -r requirements.txt

▶️ Usage

Run the application.

python src/app.py

The application guides you through the complete workflow:

  1. Select a search type
  2. Enter a search query
  3. Choose the number of papers
  4. Filter papers by publication period
  5. Sort results by relevance or newest first
  6. View search results
  7. Export results to Markdown
  8. Download research paper PDFs

📸 Screenshots

🔍 Search Interface

Search Demo


📄 Search Results

Displays paper titles, authors, publication dates, and search details.

Search Results


📥 PDF Download

Download all papers or selected research papers directly from the terminal.

PDF Download


📋 Example Workflow

Choose Search Type
        ↓
Enter Search Query
        ↓
Select Number of Papers
        ↓
Choose Publication Filter
        ↓
Choose Sorting Method
        ↓
View Search Results
        ↓
Generate Markdown Report
        ↓
Download PDFs

💡 Future Improvements

  • IEEE Xplore API integration
  • Semantic Scholar API integration
  • Crossref API support
  • BibTeX citation export
  • DOI search support
  • AI-powered paper summarization
  • Streamlit web interface
  • Advanced search filters

🤝 Contributing

Contributions are welcome!

If you'd like to improve PaperSage:

  1. Fork the repository
  2. Create a feature branch
  3. Commit your changes
  4. Push your branch
  5. Open a Pull Request

👩‍💻 Author

Devika B Raj

🎓 B.Tech in Robotics and Automation

🐙 GitHub: https://github.com/devikabraj08-ai

💼 LinkedIn: https://www.linkedin.com/in/devika-b-raj-778785329/


📄 License

This project is licensed under the MIT License. See the LICENSE file for more details.

About

A Python-based research paper explorer that searches arXiv, filters results, exports Markdown notes, and downloads research paper PDFs.

Resources

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages