Metadata-Version: 1.1
Name: random-cat
Version: 1.0.1
Summary: Modul/Command Line Tool to get cat images
Home-page: https://github.com/gravmatt/random-cat
Author: René Tanczos
Author-email: gravmatt@gmail.com
License: MIT
Description: # random-cat
        
        random-cat is a amazing modul to get cat images. This Project won't be
        posible without the great Cat API (http://thecatapi.com).
        
        ## Big Thanks to the great Cat API
        
        Go and visit [http://thecatapi.com](http://thecatapi.com)
        
        ![alt text](http://thecatapi.com/api/images/get?type=gif "See? amazing!")
        
        **Python 2 and 3 compatible**
        
        ## Installation
        
        Install through **pip**.
        
        ```
        $ pip install random-cat
        ```
        
        or get from source
        
        ```
        $ git clone https://github.com/gravmatt/random-cat
        $ cd random-cat
        $ python setup.py install
        ```
        
        ## Usage
        
        The cat module has just one function **getCat()** with three optional arguments.
        
        ### Arguments
        
        **directory** - default is the current directory
        
        **filename** - default is a unique id
        
        **format** - default is _png_. optional _png_, _jpg_ and _gif_ is available
        
        ```
        import cat
        
        # cat.getCat(directory=None, filename=None, format='png')
        
        cat.getCat(directory='/users/tor', filename='cat', format='gif')
        
        # /users/tor/cat.gif
        ```
        
        The function return the image name (absolute path if directory is specified) of the image.
        
        ### Command Line
        
        You can also request an image on the terminal.
        
        ```
        $ randomcat [format] [file]
        
        # Example:
        
        $ randomcat gif /users/tor/cat.gif
        ```
        
        The two arguments _format_ and _file_ are optional.
        
        You can select the formats _png_, _jpg_ or _gif_.
        
        The command return the filename/absolute path of the image to the standard output (stdout).
        
        ### Licence
        
        The MIT License (MIT)
        
Keywords: cat kitten fun
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Topic :: Terminals
Classifier: Intended Audience :: End Users/Desktop
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: POSIX
Classifier: Operating System :: Microsoft :: Windows
Classifier: Programming Language :: Python
Classifier: Topic :: Artistic Software
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.2
Classifier: Programming Language :: Python :: 3.3
