https://github.com/megatron-xcoder/get_paper_project
This project fetches and filters PubMed papers based on author affiliations, allowing users to perform custom searches and save the results.
https://github.com/megatron-xcoder/get_paper_project
Last synced: 3 months ago
JSON representation
This project fetches and filters PubMed papers based on author affiliations, allowing users to perform custom searches and save the results.
- Host: GitHub
- URL: https://github.com/megatron-xcoder/get_paper_project
- Owner: Megatron-XCoder
- Created: 2025-01-06T21:11:49.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-01-10T13:45:59.000Z (over 1 year ago)
- Last Synced: 2025-01-20T10:17:16.474Z (over 1 year ago)
- Language: Jupyter Notebook
- Size: 265 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Get Papers List
This project fetches and filters PubMed papers based on author affiliations, allowing users to perform custom searches and save the results.
## Features
- Fetch PubMed papers based on a user-defined search query.
- Filter papers using specific criteria (e.g., author affiliations).
- Save filtered results to a specified file.
- Debug mode for additional insights during execution.
## Installation
1. Clone the repository:
```bash
git clone https://github.com/Megatron-XCoder/Get_Paper_Project.git
cd get-papers-list
```
2. Install dependencies:
```bash
poetry install
```
---
## Usage
Run the script using Poetry:
### Basic Usage:
```bash
poetry run get-papers-list ""
```
### Options:
- **`-d` / `--debug`**: Enable debug mode to view detailed logs.
- **`-f ` / `--file `**: Specify the filename to save results.
- **`-h` / `--help`**: Show the help message and usage information.
### Examples:
1. **Basic Query**:
```bash
poetry run get-papers-list "cancer research on kidney and brain"
```
2. **With Debug Mode**:
```bash
poetry run get-papers-list "machine learning and the rise on AI" --debug
```
3. **Save Results to a File**:
```bash
poetry run get-papers-list "human psychology and body language" --file genetics.csv
```
4. **Show Help**:
```bash
poetry run get-papers-list -h
```
---
## Dependencies
This project uses the following Python package:
- [requests](https://pypi.org/project/requests/): For making HTTP requests.
Dependencies are managed with Poetry. All required packages are listed in the `pyproject.toml` file.
---
## Debugging
Enable debug mode using the `-d` or `--debug` flag to display detailed logs about the script's execution, including fetched and filtered data.
---