Simple access to Google Scholar authors and citations
Project description
scholarly
scholarly is a module that allows you to retrieve author and publication information from Google Scholar in a friendly, Pythonic way without having to solve CAPTCHAs.
Installation
Use pip to install the latest release from pypi:
pip3 install scholarly
or pip to install from github:
pip3 install -U git+https://github.com/scholarly-python-package/scholarly.git
scholarly follows Semantic Versioning.
Optional dependencies
-
geckodriver provides the browser capabilities that may be needed to fully utilize the library. Currently, if a Scholar profile has more than 20 co-authors,
geckodriveris needed to fetch the complete list. If not installed,scholarlywill fetch only up to 20 co-authors.To install
geckodriver, download the latest version from their Github repo and the executable should be in the system path. Follow the appropriate installation instructions: macOS | Ubuntu | Windows -
Tor:
scholarlycomes with a handful of APIs to set up proxies to circumvent anti-bot measures. Tor methods are deprecated since v1.5 and are not actively tested or supported. If you wish to use Tor, installscholarlyusing thetortag aspip3 install scholarly[tor]
Tests
To check if your installation is succesful, run the tests by executing the test_module.py file as:
python3 test_module
or
python3 -m unittest -v test_module.py
Documentation
Check the documentation for a complete API reference and a quickstart guide.
Examples
from scholarly import scholarly
# Retrieve the author's data, fill-in, and print
# Get an iterator for the author results
search_query = scholarly.search_author('Steven A Cholewiak')
# Retrieve the first result from the iterator
first_author_result = next(search_query)
scholarly.pprint(first_author_result)
# Retrieve all the details for the author
author = scholarly.fill(first_author_result )
scholarly.pprint(author)
# Take a closer look at the first publication
first_publication = author['publications'][0]
first_publication_filled = scholarly.fill(first_publication)
scholarly.pprint(first_publication_filled)
# Print the titles of the author's publications
publication_titles = [pub['bib']['title'] for pub in author['publications']]
print(publication_titles)
# Which papers cited that publication?
citations = [citation['bib']['title'] for citation in scholarly.citedby(first_publication_filled)]
print(citations)
IMPORTANT: Making certain types of queries, such as scholarly.citedby or scholarly.search_pubs, will lead to Google Scholar blocking your requests and may eventually block your IP address.
You must use proxy services to avoid this situation.
See the "Using proxies" section in the documentation for more details. Here's a short example:
from scholarly import ProxyGenerator
# Set up a ProxyGenerator object to use free proxies
# This needs to be done only once per session
pg = ProxyGenerator()
pg.FreeProxies()
scholarly.use_proxy(pg)
# Now search Google Scholar from behind a proxy
search_query = scholarly.search_pubs('Perception of physical stability and center of mass of 3D objects')
scholarly.pprint(next(search_query))
scholarly also has APIs that work with several premium (paid) proxy services.
scholarly is smart enough to know which queries need proxies and which do not.
It is therefore recommended to always set up a proxy in the beginning of your application.
Disclaimer
The developers use ScraperAPI to run the tests in Github Actions.
The developers of scholarly are not affiliated with any of the proxy services and do not profit from them. If your favorite service is not supported, please submit an issue or even better, follow it up with a pull request.
License
The original code that this project was forked from was released by Luciano Bello under a WTFPL license. In keeping with this mentality, all code is released under the Unlicense.
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 scholarly-1.5.0a0-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 31c4972280fd45fcccfff82ec60bc974af6b0aeb2ba50f6d22883922a88eed19 |
|
| MD5 | 8ac3b46950498b3c93df036076315f45 |
|
| BLAKE2b-256 | 9053576f3f54575243ab71cbf35a7ac56aac2637e5e17db16501c7ddecee3b77 |
