Metadata-Version: 1.1
Name: katcr
Version: 0.1.2
Summary: Kickasstorrents search lib with python3.5
Home-page: https://github.com/XayOn/katcr
Author: David Francos Cuartero
Author-email: opensource@davidfrancos.net
License: Apache-2
Description: .. image:: http://i.imgur.com/ofx75lO.png
           :align: center
        
        .. image:: https://img.shields.io/pypi/dm/katcr.svg?maxAge=2592000
        .. image:: https://img.shields.io/github/stars/xayon/katcr.svg?style=social&label=Star&maxAge=2592000
        
        \:tv\: Python3 + KickAssTorrents | CLI | Telegram
        =================================================
        
        Python3.5 library to search in kickasstorrents (`kat.cr <http://kat.cr>`)
        
        It's also a **telegram bot** and a **command line interface** :wink:
        
        .. contents:: :local:
        
        
        \:notebook\: Library Usage
        ---------------------------
        
        KATcr uses **python3.5**'s new **async def**
        `(pep-492) <https://www.python.org/dev/peps/pep-0492/>`_ syntax.
        
        For search, it just has a simple coroutine, **search_magnets**,
        that accepts a search term, the page number to return, and a type (
        type is either **"torrent"** or **"magnet"**)
        
        Sample code for getting the first page of results::
        
            from katcr import search_magnets
        
            loop = asyncio.get_event_loop()
            result = loop.run_until_complete(
                search_magnets("ubuntu", 1, loop, "torrent"))
        
            for url, name in result:
                print("{}: {}".format(name, url))
        
        
        **This library also comes with a command line interface and a telegram bot!**
        
        
        
        \:tv\: katcr - kickasstorrents command line interface
        ------------------------------------------------------
        
        katcr comes with a simple but powerful command line interface, able to
        return either magnets or torrents.
        
        
        .. image:: http://i.imgur.com/gOo3mqf.gif
        
        
        Usage
        +++++
        
        ::
        
            Easy-as-it-gets python3.5 library to search magnets
            in kickasstorrents (kat.cr)
        
            Usage:
                katcr --search=<SEARCH_TERM> --pages=<PAGES_NUM> --type=<TYPE> [--interactive]
        
            Options:
                --search=<SEARCH_TERM>   Search term(s)
                --pages=<PAGES_NUM>      Number of pages to lookup
                --type=<magnet|torrent>  Type
                -i --interactive         Activate interactive menu to torrent selection
                -h --help                Show this screen
        
            Examples:
            	katcr --search "Search terms" --pages 3
            	katcr --search "Search terms" --pages 1 --interactive
            	katcr --search "Search terms" --pages 1 --type=magnet
            	katcr --search "Search terms" --pages 1 --type=torrent
            	katcr --pages 1
        
        
        \:space_invader\: KATBot - Kickasstorrents telegram bot
        --------------------------------------------------------
        
        Katcr also comes with a telegram bot entry point.
        
        It's a simple bot that replies with search results for each message it gets.
        It returns links to .torrent files from KAT.cr for the first page of results.
        
        .. image:: http://i.imgur.com/qywHKHT.gif
        
        Usage
        +++++
        
        ::
        
            Telegram bot to query kat.cr
        
            Usage:
                katcr --token <BOT_TOKEN>
        
            Options:
                --token=<BOT_TOKEN> Telegram bot token
        
            Examples:
                katcr --token 123123:123123
        
        
        
        \:star2\: Notes
        ----------------
        
        This project is made with the best of intentions. For that times
        you need to search for somethink shared as a torrent on KAT
        (I.E, linux images). Logo is based on robot cat by
        `Arsenty <https://thenounproject.com/arsenty/>`_
        
        If you like this project, show its appreciation by starring it, if you're using
        it and want to write to me personally, feel free to do so at
        opensource@davidfrancos.net. If you've got a bug to report, please use the
        github ticketing system
        
        
Keywords: kickasstorrents
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Intended Audience :: End Users/Desktop
Classifier: License :: OSI Approved :: GNU General Public License (GPL)
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3 :: Only
