pybliometrics-dev / pybliometrics

Python-based API-Wrapper to access Scopus
https://pybliometrics.readthedocs.io/en/stable/
Other
401 stars 124 forks source link
api-wrapper bibliometrics scopus scopus-api

pybliometrics

Enables large-scale access to Elsevier's Scopus API from Python.

Documentation: https://pybliometrics.readthedocs.io

Development: https://github.com/pybliometrics-dev/pybliometrics

.. image:: https://badge.fury.io/py/pybliometrics.svg :target: https://badge.fury.io/py/pybliometrics

.. image:: https://img.shields.io/pypi/pyversions/pybliometrics.svg :target: https://img.shields.io/pypi/pyversions/pybliometrics.svg

.. image:: https://readthedocs.org/projects/pybliometrics/badge/?version=stable :target: https://readthedocs.org/projects/pybliometrics/badge/?version=stable

.. image:: https://img.shields.io/pypi/dm/pybliometrics.svg :target: https://img.shields.io/pypi/dm/pybliometrics.svg

.. image:: https://img.shields.io/pypi/l/pybliometrics.svg :target: https://img.shields.io/pypi/l/pybliometrics.svg

.. image:: https://api.codeclimate.com/v1/badges/a4d7edd206a1252dfcfe/maintainability :target: https://codeclimate.com/github/pybliometrics-dev/pybliometrics/maintainability

Example

.. example-begin .. code:: python

>>> import pybliometrics
>>> pybliometrics.scopus.init()  # read API keys
>>> # Document-specific information
>>> from pybliometrics.scopus import AbstractRetrieval
>>> ab = AbstractRetrieval("10.1016/j.softx.2019.100263")
>>> ab.title
'pybliometrics: Scriptable bibliometrics using a Python interface to Scopus'
>>> ab.publicationName
'SoftwareX'
>>> ab.authors
[Author(auid=57209617104, indexed_name='Rose M.E.', surname='Rose',
 given_name='Michael E.', affiliation='60105007'),
 Author(auid=7004212771, indexed_name='Kitchin J.R.', surname='Kitchin',
 given_name='John R.', affiliation='60027950')]
>>> 
>>> # Author-specific information
>>> from pybliometrics.scopus import AuthorRetrieval
>>> au2 = AuthorRetrieval(ab.authors[1].auid)
>>> au2.h_index
34
>>> au1 = AuthorRetrieval(ab.authors[0].auid)
>>> au1.affiliation_current
[Affiliation(id=60105007, parent=None, type='parent', relationship='author',
 afdispname=None, preferred_name='Max Planck Institute for Innovation and Competition',
 parent_preferred_name=None, country_code='deu', country='Germany',
 address_part='Marstallplatz 1', city='Munich', state='Bayern',
 postal_code='80539', org_domain='ip.mpg.de', org_URL='http://www.ip.mpg.de/')]
>>> 
>>> # Affiliation information
>>> from pybliometrics.scopus import AffiliationRetrieval
>>> aff1 = AffiliationRetrieval(au1.affiliation_current[0].id)
>>> aff1.author_count
98

.. example-end

Installation

.. installation-begin

Install the stable version from PyPI:

.. code-block:: bash

pip install pybliometrics

or the development version from the GitHub repository (requires git on your system):

.. code-block:: bash

pip install git+https://github.com/pybliometrics-dev/pybliometrics

.. installation-end

Citation

If pybliometrics helped you getting data for research, please cite our corresponding paper:

Citing the paper helps the development of pybliometrics, because it justifies funneling resources into the development. It also signals that you obtained data from Scopus in a transparent and replicable way.

Change log

Please see CHANGES.rst <./meta/CHANGES.rst>_.

Contributing

Please see CONTRIBUTING.rst <CONTRIBUTING.rst>. For a list of contributors see AUTHORS.rst <./meta/AUTHORS.rst>.

License

MIT License; see LICENSE <LICENSE>_.