Skip to main content

DOI-based paper downloader via Sci-Hub

Project description

Version License: MIT Issues Size Downloads

DoiHunter

DoiHunter is a Python package that can helps researchers download research papers using DOIs (unique identification of researcher paper) or paper titles through Crossref and Sci-Hub. Whether you're conducting research or need specific papers quickly, DoiHunter simplifies the process by automating downloads.

Features

  • Batch Download: Download multiple research papers in one go using a list of DOIs or titles.
  • Title to DOI: Retrieves DOIs using paper titles through the CrossRef API and downloads the corresponding papers.
  • Custom File Naming: Automatically names files based on paper titles for easy identification.
  • Error Handling: Logs failed downloads and provides detailed summaries after processing.

Installation

  1. First, ensure you have Python installed on your system.
  2. Install the doi_hunter package using pip:
pip install doi_hunter

Setup & Usage

Step 1: Create a Directory and Paper Title List

  • Create a directory with any name.
  • Inside that directory, create a .txt file form example paper_titles.txt.
  • This file should contain a list of paper titles or DOIs, each on a new line.

Example content for paper_titles.txt:

  • AI Ethics: Balancing Innovation with Privacy and Security in the Digital Age
  • 10.1002/er.6529
  • Prediction of daily global solar radiation using different machine learning algorithms: Evaluation and comparison

Step 2: Run the Downloader

Navigate to your created directory, then run the following command:

python -m doi_hunter paper_titles.txt --batch_size=5

Output

Once the download starts, you'll see the following output:

[INFO] Welcome to DoiHunter!
This tool helps you download research papers from Sci-Hub using DOIs or titles.
For more information and the source code, visit: https://github.com/mehmoodulhaq570

[INFO] Starting the download process...

Processing [1/3]: AI Ethics: Balancing Innovation with Privacy and Security in the Digital Age
[v] File downloaded successfully :)
Processing [2/3]: 10.1002/er.6529
[v] File already exists. Skipping download.

[SUMMARY]
Total papers in file: 2
Total successfully downloaded: 1
Total skipped files: 1
Total failed downloads: 0

Summary of Logs At the end of the process, a summary is displayed showing the total number of papers processed, successfully downloaded, skipped (if they already exist), and failed downloads.

Notes

The --batch_size option allows you to control how many papers are processed at once, useful for large datasets. The doi of the research paper must start like this 10.1016/j.rser.2016.05.022 Failed downloads are logged and can be retried later.

Contributors

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

doi_hunter-1.1.1.tar.gz (8.4 kB view details)

Uploaded Source

Built Distribution

doi_hunter-1.1.1-py3-none-any.whl (9.0 kB view details)

Uploaded Python 3

File details

Details for the file doi_hunter-1.1.1.tar.gz.

File metadata

  • Download URL: doi_hunter-1.1.1.tar.gz
  • Upload date:
  • Size: 8.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.10

File hashes

Hashes for doi_hunter-1.1.1.tar.gz
Algorithm Hash digest
SHA256 15fc041ba545793afc42bd99186ae8f81f964d99f4e5aae26e35a959e65aa75a
MD5 ed496715cc720688a142def84c3e1636
BLAKE2b-256 9cd37a26b16c227242b4ad7677bd7f46cf456d8a5643dc4f9b1fb956deaf8e58

See more details on using hashes here.

File details

Details for the file doi_hunter-1.1.1-py3-none-any.whl.

File metadata

  • Download URL: doi_hunter-1.1.1-py3-none-any.whl
  • Upload date:
  • Size: 9.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.10

File hashes

Hashes for doi_hunter-1.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 579dd4dec6ffb95c075f61a7a2ae3d4e9e5536738a5323a7db3ec674720a14a9
MD5 6a8966c45312b3e2357ebd2fd5865636
BLAKE2b-256 171919a965a371e6b7eb52164b63404308fdbed1874e895621654f1f1bb5a9bb

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page