Metadata-Version: 1.0
Name: BASC-py4chan
Version: 0.4.1
Summary: Python 4chan API Wrapper. Improved version of Edgeworth's original py-4chan wrapper.
Home-page: http://github.com/bibanon/BASC-py4chan
Author: Antonizoon (Lawrence Wu)
Author-email: sagnessagiel@gmail.com
License:             DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
                    Version 2, December 2004

 Copyright (C) 2004 Sam Hocevar <sam@hocevar.net>

 Everyone is permitted to copy and distribute verbatim or modified
 copies of this license document, and changing it is allowed as long
 as the name is changed.

            DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION

  0. You just DO WHAT THE FUCK YOU WANT TO.


Description: BASC-py4chan
        ============
        
        The Bibliotheca Anonoma's **complete Python Wrapper for the 4chan API.**
        Uses requests, respects if-modified-since headers on updating threads.
        Caches thread objects. Fun stuff.
        
        An absolute must if you want to interface with or scrape from 4chan,
        using a Python script.
        
        `You can install this wrapper library straight from
        PyPi <https://pypi.python.org/pypi/BASC-py4chan>`__.
        
        This is the Bibliotheca Anonoma StoryCorps' (BASC) updated fork of
        py4chan, based on `Edgeworth's outdated
        original. <https://github.com/e000/py-4chan>`__
        
        Changelog
        ---------
        
        Since Edgeworth has gone MIA, the BASC has adopted the project and made
        the following improvements.
        
        (we might need to move this to documentation)
        
        Changes by `antonizoon <https://github.com/antonizoon>`__:
        
        -  **4chan Link Structure Update** - 4chan has heavily reformed it's
           link structure, finally removing the strange folder structure
           inherited from the Futaba Channel.
        -  **4chan cdn Link update** - To save money on bandwidth. 4chan has
           changed it's image/thumbnail/json/css servers to a domain name with
           fewer characters.
        -  **Thread Class:** new ``filenames()`` function that return the
           filenames of all files (not thumbnails) in a thread.
        -  **Thread Class:** new ``thumbnames()`` function that return the
           filenames of all thumbnails in a thread.
        
           -  **Post Class:** new ``image_fname`` and ``thumbnail_fname``
              properties, designed for Thread Class ``filenames()`` and
              ``thumbnames()``.
        
        -  **Actual API Documentation** - Real documentation on using the
           py-4chan library is a must. For some people, it is rocket science.
        
        --------------
        
        Changes by `Anorov <https://github.com/Anorov/py-4chan>`__:
        
        -  **Anorov's underscore\_function\_notation** - Even I have to say that
           CamelCase is beginning to suck, so we've adopted Anorov's function
           notation for py4chan. This breaks API compatibility with the original
           py-4chan, but just use find/replace to change your functions.
        -  **Break up classes into separate files.** - Makes the code much
           cleaner.
        -  Thread Class: ``expand()`` function, used to display omitted posts
           and images. Used by all\_posts().
        -  Thread Class: ``semantic_thread_url()`` function, used to obtain
           4chan's new URL format, which tacks on the thread title (obtained
           from ``slug()``).
        -  Post Class: ``comment()`` has been modified to use
           ``clean_comment_body()`` when returning a comment. The raw text from
           the 4chan API can still be obtained from ``orig_comment()``.
        
           -  Util Class: ``clean_comment_body()`` function, which converts all
              HTML tags and entities within 4chan comments into human-readable
              text equivalents.(e.g. ``<br>`` to a newline, ``<a href>`` into a
              raw link)
        
        -  Board Class: ``_get_json()`` function, which dumps the raw JSON from
           the 4chan API.
        -  A whole host of new Catalog parsing functions:
        
           -  Board Class: ``refresh_cache()`` and ``clear_cache()`` - Get the
              latest Catalog of all threads in the board, or clear the current
              cache.
           -  Board Class: ``get_threads(page)`` - Get a list of all threads on
              a certain page. (Pages are now indexed starting from 1).
           -  Board Class: ``get_all_thread_ids()`` - Get a list of all thread
              IDs on the board.
           -  Board Class: ``get_all_threads()`` - Return all threads on all
              pages in the board.
        
        --------------
        
        If you're a developer that still uses Edgeworth's py-4chan, and are too
        lazy to change the function names, the BASC still maintains `an
        up-to-date, API compatible version of py-4chan
        here. <https://github.com/bibanon/py-4chan>`__
        
        Usage
        -----
        
        .. code:: python
        
            import py4chan
            b = py4chan.Board('b')
            thread = b.get_thread(423491034)
        
            print thread
        
            for file in thread.files():
                print file
                
            # In a while...
            print "I fetched", thread.update(), "new replies."
        
        API Documentation coming soon, but for now, figure it out from the
        source.
        
        License
        -------
        
        .. code:: text
        
            DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
                                Version 2, December 2004
        
             Copyright (C) 2004 Sam Hocevar <sam@hocevar.net>
        
             Everyone is permitted to copy and distribute verbatim or modified
             copies of this license document, and changing it is allowed as long
             as the name is changed.
        
                        DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
               TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
        
              0. You just DO WHAT THE FUCK YOU WANT TO.
        
        
Platform: UNKNOWN
