Metadata-Version: 2.1
Name: nlbsg
Version: 0.4.0
Summary: Python SDK for the NLB Open Web Services
Home-page: https://github.com/yi-jiayu/nlbsg
Author: Jiayu Yi
Author-email: yijiayu@gmail.com
License: MIT
Project-URL: Documentation, https://nlbsg.readthedocs.io/en/latest/
Project-URL: Source code, https://github.com/yi-jiayu/nlbsg
Project-URL: Builds, https://travis-ci.com/yi-jiayu/nlbsg
Project-URL: Coverage, https://codecov.io/gh/yi-jiayu/nlbsg
Description: .. nlbsg documentation master file, created by
           sphinx-quickstart on Mon Apr  1 15:29:49 2019.
           You can adapt this file completely to your liking, but it should at least
           contain the root `toctree` directive.
        
        Welcome to nlbsg's documentation!
        =================================
        
        .. image:: https://travis-ci.com/yi-jiayu/nlbsg.svg?branch=master
           :target: https://travis-ci.com/yi-jiayu/nlbsg
        
        .. image:: https://codecov.io/gh/yi-jiayu/nlbsg/branch/master/graph/badge.svg
           :target: https://codecov.io/gh/yi-jiayu/nlbsg
        
        .. image:: https://img.shields.io/pypi/v/nlbsg.svg
           :target: https://pypi.org/project/nlbsg/
           :alt: PyPI
        
        .. image:: https://img.shields.io/pypi/pyversions/nlbsg.svg
           :target: https://pypi.org/project/nlbsg/
           :alt: PyPI - Python Version
        
        .. image:: https://readthedocs.org/projects/nlbsg/badge/?version=latest
           :target: https://nlbsg.readthedocs.io/en/latest/?badge=latest
           :alt: Documentation Status
        
        Python wrapper for the `NLB Open Web Services <http://www.nlb.gov.sg/labs/technical-documentation/>`_.
        
        Currently supports the `Catalogue Service <http://www.nlb.gov.sg/labs/technical-documentation/#catalogue-service>`_.
        
        Installation
        ------------
        
        ::
        
            pip install nlbsg
        
        Usage example
        -------------
        
        Creating a client::
        
            from nlbsg import Client
            from nlbsg.catalogue import STAGING_URL
        
            API_KEY = 'secret_api_key'
        
            client = Client(STAGING_URL, API_KEY)
        
        Searching the catalogue::
        
            >>> from nlbsg import MediaCode
            >>> results = client.search('lord of the rings', author='tolkien', media_code=MediaCode.BOOKS, limit=3)
            >>> for title in results.titles:
            ...     print(f'Title: {title.title_name}\nISBN: {title.isbn}\nPublished: {title.publish_year}\n')
            ...
            Title: Beren and Lúthien / by  J.R.R. Tolkien ; edited by Christopher Tolkien ; with illustrations by  Alan Lee.
            ISBN: 1328915336 (paperback)
            Published: 2018
        
            Title: Beren and l℗♭©ʻthien [electronic resource]. J. R. R Tolkien.
            ISBN: 9780008214210 (electronic bk)
            Published: 2017
        
            Title: The fall of arthur [electronic resource]. J. R. R Tolkien.
            ISBN: 9780007489954 (electronic bk)
            Published: 2013
        
        Getting title details::
        
            >>> details = client.get_title_details(isbn='1328915336')
            >>> details.title_detail.summary
            "The epic tale of Beren and Lúthien became an essential element in the evolution of The Silmarillion, the myths and legends of J.R.R. Tolkien's First Age of the World. Always key to the story is the fate that shadowed their love: Beren was a mortal man, Lúthien an immortal Elf. Her father, a great Elvish lord, imposed on Beren an impossible task before he might wed Lúthien: to rob the greatest of all evil beings, Melkor, of a Silmaril.Painstakingly restored from Tolkien's manuscripts and presented for the first time as a continuous and standalone story, Beren and Lúthien reunites fans of The Hobbit and The Lord of the Rings with Elves and Men, along with the rich landscape and creatures unique to Tolkien's Middle-earth. Christopher Tolkien tells the story in his father's own words by giving its original form as well as prose and verse passages from later texts that illustrate the narrative as it changed. -- from back cover."
        
        Getting title availability::
        
            >>> availability = client.get_availability_info(isbn='1328915336')
            >>> for item in availability.items:
            ...     print(f'Branch: {item.branch_name}\nStatus: {item.status_desc}\n')
            ...
            Branch: Ang Mo Kio Public Library
            Status: Not On Loan
        
            Branch: Bukit Batok Public Library
            Status: On Loan
        
            Branch: Bedok Public Library
            Status: On Loan
        
            Branch: Bishan Public Library
            Status: Not On Loan
        
            Branch: Bukit Panjang Public Library
            Status: Not On Loan
        
            Branch: Choa Chu Kang Public Library
            Status: On Loan
        
            Branch: Central Public Library
            Status: Not On Loan
        
            Branch: Clementi Public Library
            Status: On Loan
        
            Branch: Cheng San Public Library
            Status: On Loan
        
            Branch: Geylang East Public Library
            Status: Not On Loan
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3.7
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.7
Description-Content-Type: text/x-rst
