PyPaperBot Documentation

Because numpy cannot be installed directly in Termux, follow these steps to set up the environment before installing PyPaperBot:

1. Install wget and the pointless repository.
2. Install numpy.
3. Set CFLAGS to avoid specific compilation errors.
4. Install pandas.
5. Install PyPaperBot via pip.

pkg install wget
wget https://its-pointless.github.io/setup-pointless-repo.sh
pkg install numpy
export CFLAGS="-Wno-deprecated-declarations -Wno-unreachable-code"
pip install pandas
pip install PyPaperbot

PyPaperBot can be installed via pip from PyPI.

Windows Users: If you encounter the error error: Microsoft Visual C++ 14.0 is required.., you must install Microsoft C++ Build Tools or Visual Studio.

pip install PyPaperBot

You can download a single paper using its DOI or a list of DOIs from a text file.

Example: Download a single paper by DOI and use the DOI as the filename:

python -m PyPaperBot --doi="10.0086/s41037-711-0132-1" --dwn-dir="C:\User\example\papers" --use-doi-as-filename

Example: Download papers from a list of DOIs in a text file:

python -m PyPaperBot --doi-file="C:\User\example\papers\file.txt" --dwn-dir="C:\User\example\papers"

Use the --query argument to search Google Scholar. You can specify a range of pages using --scholar-pages and filter by year using --min-year.

Example: Download max 30 papers from first 3 pages (from 2018) using a specific Sci-Hub mirror:

python -m PyPaperBot --query="Machine learning" --scholar-pages=3 --min-year=2018 --dwn-dir="C:\User\example\papers" --scihub-mirror="https://sci-hub.do"

Example: Download papers from a specific page range and skip certain words:

python -m PyPaperBot --query="Machine learning" --scholar-pages=4-7 --dwn-dir="C:\User\example\papers" --skip-words="ai,decision tree,bot"

If you encounter bot detection or access issues, you can use proxies. You can provide a comma-separated list of proxies or use --single-proxy if the list causes errors. Always place the proxy argument at the end.

Example: Using multiple proxies:

python -m PyPaperBot --query=rheumatoid+arthritis --scholar-pages=1 --scholar-results=7 --dwn-dir=/download --proxy="http://1.1.1.1::8080,https://8.8.8.8::8080"

Example: Using a single proxy:

python -m PyPaperBot --query=rheumatoid+arthritis --scholar-pages=1 --scholar-results=7 --dwn-dir=/download --single-proxy="http://1.1.1.1::8080"