Metadata-Version: 2.1
Name: sfpl
Version: 1.0.2
Summary: Python Scraper for SFPL Website
Home-page: https://github.com/kajchang/sfpl-scraper
Author: Kai Chang
License: MIT
Description: # SFPL Scraper
        ![travis](https://travis-ci.org/kajchang/sfpl-scraper.svg?branch=master)
        ![pypi](https://badge.fury.io/py/sfpl.svg)
        
        Python Package for accessing data on the SFPL Website in a Python program.
        
        # Usage
        
        ```pip install sfpl``` or clone / download this repository and ```python setup.py install```.
        
        ```from sfpl import SFPL```
        
        ```sfpl = SFPL('barcode', 'pin')```
        
        The current methods are ```getHolds()```, ```getCheckouts()```, ```getForLater()```, ```getInProgress()``` and ```getCompleted()```.
        
        ```getCheckouts()``` returns a list of dictionaries with basic information on books the user has checked out, along with a due date:
        
        ```
        [
            {
                "title": "Blockchain and the Law",
                "author": "De Filippi, Primavera",
                "medium": "Book",
                "publication year": 2018,
                "duedate": "Jun 13, 2018",
                "subtitle": "The Rule of Code"
            }, ...
        ```
        
        ```getHolds()``` returns a list of dictionaries with basic information on books the user has requested, along with the request status:
        ```
        [
            {
                "title": "Fundamentals of Deep Learning",
                "author": "Buduma, Nikhil",
                "medium": "Book",
                "publication year": 2017,
                "status": "In Transit to WEST PORTAL BRANCH",
                "subtitle": "Designing Next-generation Machine Intelligence Algorithms"
            }, ...
        ```
        
        ```getForLater()``` returns a list of dictionaries with basic information on the books on your For Later shelf:
        ```
        [
            {
                "title": "Cryptocurrency",
                "author": "Goleman, Travis",
                "medium": "Downloadable Audiobook",
                "publication year": 2018,
                "subtitle": "Mining, Investing and Trading in Blockchain for Beginners"
            }, ...
        ]
        ```
        
        ```getInProgress()```, ```getCompleted()``` are identical as ```getForLater()``` for their respective shelves.
        
        ## TODO:
        
        Calendars, Events, and Searches.
        
Platform: UNKNOWN
Description-Content-Type: text/markdown
