GitHub - jjehannet/scholarref

Branches Tags

Name		Name	Last commit message	Last commit date
Latest commit History 29 Commits
LICENSE		LICENSE
Makefile		Makefile
README		README
articlesearch		articlesearch
getdoi		getdoi
getref		getref
scholarref		scholarref
shdl		shdl

Repository files navigation

# scholarref

POSIX shell tools to extract, fetch, and parse DOIs and BiBTeX bibliography
references. The following scripts provide the core functionality:

- getdoi: takes a file or a search query and returns its DOI
- getref: takes a DOI and returns the corresponding BiBTeX entry
- shdl: takes a DOI and fetches the corresponding pdf from sci-hub.tw

The script `scholarref` is an example where `getref` and `getdoi` are
combined to obtain a BiBTeX entry from a search query or a PDF. The
`articlesearch` script is an interactive PDF opener, reference manager,
and publication fetcher for X11 using dmenu[0] and the above tools.

DISCLAIMER:
The functionality provided by these programs depends on communication
with third party webpages, which may or may not be permitted by law and
the terms of service upheld by the third parties.  What is demonstrated
here is an example only.  Use of the tools is entirely under your own
responsibility.

## Installation
Use locally or run `make install` to install under `/usr/local/bin`. Run
`make uninstall` to remove.

## Author
Anders Damsgaard, https://src.adamsgaard.dk/scholarref

## License
GNU Public License v.3 or later. See LICENSE for details.

## Usage
usage: getdoi [OPTIONS] QUERY
returns the publication DOI from http://api.crossref.org/works
where QUERY can consist of publication title, author, DOI, ORCID id,
or a PDF file. In case a file is specified, getdoi will attempt to
extract the DOI from it.
If no QUERY is specified, this program will expect a QUERY as stdin.

OPTIONS are one or more of the following:
   -h, --help          show this message
   -v, --version       show version and license information
   -V, --verbose       show verbose information
   -t, --tor-socks     use torsocks for HTTP requests
   -n, --notify        send result as desktop notification
   -N, --number NUM    return NUM results (default 1)
   -c,  --clip         paste DOI to clipboard (requires xclip)
   -o,  --open         open DOI as url in browser
   --                  do not consider any following args as options

usage: getref [OPTIONS] [DOIs ...]
will attempt to get a BibTeX citation from https://doi.org
If no DOIs are specified, this program will expect DOIs as stdin.

OPTIONS are one or more of the following:
   -h, --help          show this message
   -v, --version       show version and license information
   -V, --verbose       show verbose information
   -t, --tor-socks     use torsocks for HTTP requests
   -j, --full-journal  return full journal name in citation
   -a, --full-author   do not shorten author names
   -n, --no-newline    suppress trailing newline but prepend with newline
   -N, --notify        send desktop notification when complete
   --                  do not consider any following args as options

usage: shdl [OPTIONS] [DOIs ...]
will fetch each DOI from http://sci-hub.tw
If no DOI is specified, this program will expect DOIs as stdin.
The program extracts the DOI if a full doi.org URL is passed to it.
If the PDF download fails, e.g. due to captias, a tor-browser or 
alternatively the system default browser will open sci-hub.

OPTIONS are one or more of the following:
   -h,  --help          show this message
   -v,  --version       show version and license information
   -V,  --verbose       show verbose information
   -t,  --tor-socks     use torsocks for requests to sci-hub
   -b,  --browser       open sci-hub in browser immediately
   -r,  --reference     add reference to bibliography using scholarref
   -n,  --notify        send desktop notification when complete
   -o,  --open          open downloaded document when complete
   --                   do not consider any following args as options

## References
0: https://tools.suckless.org/dmenu/