/GoogleScholarReport

collect article related data from google scholar

Primary LanguagePythonBSD 2-Clause "Simplified" LicenseBSD-2-Clause

Google Scholar Report

Description

Google Scholar Report is a tool for collecting data from Google Scholar profiles and storing it with metadata for each scientific paper. This tool has three main forms of use: generic, authenticated and admin; which differ in the amount and quality of the collected metadata. The default output is xlsx.

Usage from python-cli

Installation Package

$pip install GoogleScholarReport

For the first option of use (generic), use:

>>> from GoogleScholarReport import collector
>>> collector.gsr('url_to_google_scholar_profile', ouput='json')

Example

>>> from GoogleScholarReport import collector
>>> collector.gsr('https://scholar.google.com/citations?user=1sKULCoAAAAJ&hl=en', ouput='json')

For the second option of use (user authenticate):

>>> from GoogleScholarReport import collector
>>> collector.gsr('url_to_google_scholar_profile',email='user_email_google_scholar',password='pass_user_gs',' ouput='json')

Finally, for admin mode, use:

>>> from GoogleScholarReport import collector
>>> collector.gsr('url_to_google_scholar_profile',email='user_email_google_scholar',password='pass_user_gs', ouput='some_ouput(csv,json)',admin=True)

Usage from command-line

From command line, this tool has three main forms of use: generic, authenticated and admin; which differ in amount and quality of the collected metadata results.

For the first option of use (generic), use:

collector "url_for_the_google_scholar_profile"

Example:

collector "https://scholar.google.com/citations?user=1sKULCoAAAAJ&hl=en"

The above option return one Excel file, google_scholar_report_user.xlsx, in the current working directory with the following metadata:

'title', 'author', 'journal', 'volume', 'number','pages', 'year', 'cite_id', 'cites', 'TitleU'.

If you want the output in csv or json format aggregate the bellow flag and the desire output format, for instance:

collector "url_for_the_google_scholar_profile" --output csv

For the second option of use (authenticated user):

collector "url_for_the_google_scholar_profile" --email <email> --password <password>

This return one Exce file, google_scholar_report_user.xlsx, in the current working directory with the following metadata:

'cite_id', 'cites', 'publisher', 'year', 'pages', 'number', 'volume', 'journal', 'author', 'title','ENTRYTYPE', 'ID', 'school', 'booktitle', 'organization', 'note','month', 'institution'

   Finally, for admin mode, use:  

collector "url_for_the_google_scholar_profile" --email <email> --password <password> --admin

This returns by default an xlsx file, google_scholar_report_user.xlsx, with the same metadata that option two, plus the field 'bibtex'.

In general this command line tool have the following form:

collector "url_for_the_google_scholar_profile" --email <user_email> --password <password> --output <format> --admin