A package based on SciHub and Google Scholar that can download articles given DOI, website address or keywords.
Project description
getarticle
Description
getarticle
is a package based on SciHub and Google Scholar that can download articles given DOI, website address or keywords.
Install
Using pip
to install:
# for latest version (recommended)
pip install git+https://github.com/HTian1997/getarticle.git
# for last release
pip install getarticle
Features & Usage
getarticle
can be imported in Python or used as command line.
To use in command line:
usage: getarticle [-h] [-i INPUT] [-o OUTPUT] [-sd SETDOWNLOAD]
getarticle CLI
optional arguments:
-h, --help show this help message and exit
-i INPUT, --input INPUT
article DOI or website
-o OUTPUT, --output OUTPUT
download direction
-sd SETDOWNLOAD, --setdownload SETDOWNLOAD
set default download direction
Example:
getarticle -i 10.1126/science.abc7424 -o /Users/haotian/Desktop
Please change the download direction to your own. The download direction is the current direction in terminal by default. To change the default download direction, use -sd
option.
Example:
getarticle -sd /Users/haotian/Downloads
# will download to /Users/haotian/Downloads folder
getarticle -i 10.1126/science.abc7424
getarticle
can also download article of the current webpage (only supported for MacOS Safari).
Example:
# current Safari webpage:
# https://www.nature.com/articles/s41467-020-16670-2
# download article of current webpage to default direction
getarticle
To use in Python:
- Initialization
from getarticle import GetArticle
ga = GetArticle()
- Download a single article given DOI or website address.
ga.input_article("10.1126/science.abc7424")
ga.download()
Notes:
- Once downloaded, all stored articles will be cleared;
- For
download
function,direction
argument is the current direction by default; - Downloaded article is named as either "article title.pdf" if successfull or "year-month-day-hour-minute-second.pdf".
- Download multiple articles.
ga.input_article("https://www.nature.com/articles/s41594-020-0468-7#article-info")
ga.input_article("10.1038/s41893-020-0581-y")
ga.download()
Notes:
- Repeatedly using
article
function can save multiple articles. getarticle
will not save & download duplicate articles;
- Download related articles given keywords. Keywords can be article names, research fields or author names. (This feature is under development.)
ga.search("Deep Dive into Machine Learning Models for Protein Engineering")
ga.search("SARS, Computation", num_of_page=2)
ga.search("Roberta Croce")
ga.download()
Notes:
num_of_page
is the corresponding number of page in Google Scholar.num_of_page
is 1 by default.
- Show currently stored articles / delete article by index.
ga.cur_articles()
ga.remove_article()
License
MIT
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for getarticle-0.0.6-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f3040fd44a0037e34a022824e627f1e10f22682c3831b2e17b25b47f839d0ea6 |
|
MD5 | d6b2927a88ce91717c320521b8fcb9fd |
|
BLAKE2b-256 | db22b0b49f653df252de361b2d79104985e58e00e629028db70b028492453bd8 |