Metadata-Version: 1.0
Name: scieloapi
Version: 0.2
Summary: Thin wrapper around the SciELO Manager RESTful API.
Home-page: http://docs.scielo.org
Author: SciELO
Author-email: scielo-dev@googlegroups.com
License: FreeBSD 2-clause::

    Copyright (c) 2013, SciELO <scielo-dev@googlegroups.com>
    All rights reserved.

    Redistribution and use in source and binary forms, with or without modification,
    are permitted provided that the following conditions are met:

        Redistributions of source code must retain the above copyright notice,
        this list of conditions and the following disclaimer.

        Redistributions in binary form must reproduce the above copyright notice,
        this list of conditions and the following disclaimer in the documentation
        and/or other materials provided with the distribution.

    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
    ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
    WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
    IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
    INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
    NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
    OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
    WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
    ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
    OF SUCH DAMAGE.

Description: scieloapi.py
        ============
        
        Thin wrapper around the SciELO Manager RESTful API.
        
        [![Build Status](https://travis-ci.org/scieloorg/scieloapi.py.png?branch=master)](https://travis-ci.org/scieloorg/scieloapi.py)
        
        Usage example:
        
            import scieloapi
        
            client = scieloapi.Client('some.user', 'some.api_key')
            
            for journal in client.journals.all():
                print journal['id'], journal['title']
        
        
        How to install
        --------------
        
        You can install it via `pip`, directly from the github repo:
        
            pip install -e git+git://github.com/scieloorg/scieloapi.py.git#egg=scieloapi
        
        
        Basics
        ------
        
        When a `Client` instance is initialized, the process automaticaly instrospects the API server
        in order to make available only the endpoints part of the specified API version. The API version
        may be passed as keyword argument `version` when creating the `Client` instance. If ommited, 
        the highest version is used.
        
        
            >>> client = scieloapi.Client('some.user', 'some.api_key', api_uri='http://manager.scielo.org/api/', version='v1')
            
        
        Listing available endpoints:
        
            >>> client.endpoints
            [u'pressreleases', u'users', u'sections', u'sponsors', u'collections', u'changes', u'apressreleases', u'uselicenses', u'journals', u'issues']
            >>>
        
        Listing all items of an endpoint:
        
            >>> for journal in client.journals.all(): print journal['title']
            ...
            Acta Médica Costarricense
            Acta Pediátrica Costarricense
            Actualidades Investigativas en Educación
            Adolescencia y Salud
            Agronomía Costarricense
            Agronomía Mesoamericana
            Annali dell'Istituto Superiore di Sanità
            Arquivos em Odontologia
            Brazilian Journal of Oral Sciences
            Bulletin of the World Health Organization
            Cadernos de Saúde Pública
            >>> 
        
        
        Listing items matching some params:
        
            >>> for journal in client.journals.filter(collection='saude-publica'): print journal['title']
            ...
            Annali dell'Istituto Superiore di Sanità
            Bulletin of the World Health Organization
            Cadernos de Saúde Pública
            Ciência & Saúde Coletiva
            Gaceta Sanitaria
            MEDICC Review
            Revista Brasileira de Epidemiologia
            Revista Cubana de Salud Pública
            Revista de Salud Pública
            >>>
        
        
        Getting a specific item:
        
            >>> journal = client.journals.get(62)
            >>> journal['title']
            u'Acta M\xe9dica Costarricense'
            >>>
        
        
        Use license
        -----------
        
        This project is licensed under FreeBSD 2-clause. See `LICENSE` for more details.
        
        
        History
        =======
        
        0.2
        ---
        
        * Slumber dependency was removed. The module `scieloapi.httpbroker` was created
          to deal with http requests and responses.
        * Better test reports now using Nosetests + coverage.
        * Added method `Client.fetch_relations` to fetch all first-level relations of
          a document and replace the value by the full document.
        
        
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python
Classifier: Topic :: Software Development :: Libraries :: Python Modules
