Metadata-Version: 2.1
Name: sfpl
Version: 1.1.9
Summary: Unofficial Python API for SFPL
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 account, book, and author data from the SFPL Website.
        
        # Usage
        
        Install the package:
        
        ```$ pip install sfpl```
        
        Clone / download this repository and ```$ python setup.py install``` or ```$ pip install .```.
        
        
        The package has 3 classes: SFPL, Book and Author.
        
        # SFPL Class
        
        The SFPL class is allows you to access SFPL accounts and all their holds, checkouts, and shelves.
        
        # Methods
        
        # Read Methods
        
        ```SFPL.getHolds()``` - Returns a list containing Book objects for each book in your holds.
        
        ```SFPL.getCheckouts()``` - Returns a list containing Book objects for each book you've checked out.
        
        ```SFPL.getForLater()```, ```SFPL.getInProgress()``` and ```SFPL.getCompleted()``` - Return a list containing Book objects for each book in the respective shelves.
        
        # Write Methods
        
        ```SFPL.hold(book)``` - Takes a Book object as a parameter and holds the book.
        
        TODO:
        Holding errors
        
        # Example
        
        ```python
        >>> from sfpl import SFPL
        >>> sfpl = SFPL('barcode', 'pin')
        >>> [book.title for book in sfpl.getCheckouts()]
        ['On Intelligence', 'Money', 'Deep Learning', 'Make your Own Neural Network']
        ```
        
        # Book Class
        
        Returned by other classes, or can be created independently.
        
        # Attributes
        
        ```title``` - Title of the book.
        
        ```author``` - Search object for books by the same author.
        
        ```subtitle``` - The book's subtitle.
        
        ```ID``` - The SFPL's id for the book. (used for holding / looking up details)
        
        ```status``` - Status of the book, if applicable. (duedate, hold position, etc.)
        
        # Methods
        
        ```Book.getDescription()``` - Returns the SFPL's description of the book.
        
        ```Book.getDetails()``` - Returns details on the book. (ISBN, Call Number, etc.)
        
        ```Book.getKeywords()``` - Returns a list of terms from the book.
        
        # Example
        
        Returned by SFPL / Author class methods:
        
        ```python
        >>> from sfpl import SFPL
        >>> sfpl = SFPL('barcode', 'pin')
        >>> checkedOutBooks = sfpl.getCheckouts()  # Get all checked out books
        >>> book = checkedOutBooks[0]  # Get the first book in the list
        >>> book.title
        'Basics of Web Design'
        >>> book.subtitle
        'HTML5 & CSS3'
        >>> book.status
        'Due Jun 28, 2018'
        ```
        
        Created independently:
        
        ```python
        >>> from sfpl import Book
        >>> book = Book('Python')
        >>> book.getDescription()
        'Python is a remarkably powerful dynamic programming language used in a wide variety of situations such as Web, database access ...'
        >>> book.getDetails()
        {'Publisher': '[San Francisco, California] :, Peachpit Press,, [2014]', 'Edition': 'Third edition', 'ISBN': ['9780321929556', '0321929551'], ...}
        >>> book.getKeywords()
        ['Introduction to programming', 'Arithmetic, strings, and variables', 'Writing programs', 'Flow of control', 'Functions', ...]
        ```
        
        # Search Class
        
        Returned in Book objects from SFPL class methods, or can be created independently.
        
        # Attributes
        
        ```term``` - Name of the author.
        ```_type``` - Type of search (author, keyword, tag). Defaults to keyword.
        
        # Methods
        
        ```Search.getBooks(pages=1)``` - Get specified number of pages of books (5 / page) by the author.
        
        # Examples
        
        Returned by SFPL class methods:
        
        ```python
        >>> from sfpl import SFPL
        >>> sfpl = SFPL('barcode', 'pin')
        >>> checkedOutBooks = sfpl.getCheckouts()  # Get all checked out books
        >>> book = checkedOutBooks[0]  # Get the first book in the list
        >>> book.author.term
        'Felke-Morris, Terry'
        >>> book.
        ```
        
        Created independently:
        
        ```python
        >>> from sfpl import Search
        >>> author = Search('J.K. Rowling', _type='author')
        >>> books = author.getBooks()  # Get first page of books written by J.K. Rowling
        >>> book = books[0]  # Get the first book in the list
        >>> book.title
        "Harry Potter and the Sorcerer's Stone"
        ```
        
        # TODO:
        
        Calendars
        
        Events
        
        Better Status Messages
        
Platform: UNKNOWN
Description-Content-Type: text/markdown
