Metadata-Version: 1.1
Name: pyaltmetric
Version: 0.2.0
Summary: Python Altmetric API v1 wrapper
Home-page: https://github.com/wearp/pyaltmetric
Author: Will Earp
Author-email: will.earp@icloud.com
License: BSD
Description: ===============================
        pyAltmetric
        ===============================
        
        .. image:: https://badge.fury.io/py/pyaltmetric.png
            :target: http://badge.fury.io/py/pyaltmetric
        
        pyAltmetric is a python wrapper for `Altmetric API v1 <http://api.altmetric.com>`_. It provides an API for downloading and reading citations both individually and in bulk.
        
        Installation
        ------------
        ::
        
            pip install pyaltmetric
        
        Usage
        -----
        **Fetching by individual citations by identifiers**::
            
            from pyaltmetric import Altmetric
        
            a = Altmetric()
        
            a.id("241939")
            a.doi("10.1038/news.2011.490")
            a.pmid("21148220")
            a.rxiv("1108.2455")
            a.ads("2012apphl.100y3104b")
        
            a = Altmetric("api_key_goes_here")
        
        **Querying the Altmetric.com database**::
        
            a.citations("1w", page=1, nlmid="0410462")
        
        **Reading a citation**::
            
            
            >>> from pyaltmetric import Altmetric, Citation
            >>>
            >>> b = a.id("241939")
            >>> c = Citation(b)
            >>> print c.title
            u'Rebuilding Global Fisheries'
            >>>
            >>> c   # provides a snapshot of a citation's coverage across platforms.
            Altmetrics on: "Rebuilding Global Fisheries" with doi 10.1126/science.1173146 
            published in Science.
        
            All Posts      14
            Tweets          6
            Facebook        1
            Google+         0
            Reddit          0
            Blogs           2
        
            >>>
         
        * Free software: BSD license
        
        
        
Keywords: Altmetric altmetric altmetrics api wrapper
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Topic :: Software Development :: Libraries :: Python Modules
