Metadata-Version: 2.0
Name: tinypng
Version: 3.0.0
Summary: Access api.tinypng.org from the shell and python scripts
Home-page: https://github.com/mbarkhau/tinypng/
Author: Manuel Barkhau
Author-email: mbarkhau@gmail.com
License: BSD License
Keywords: p,n,g, ,i,m,a,g,e, ,c,o,m,p,r,e,s,s,i,o,n, ,t,i,n,y,p,n,g, ,s,h,r,i,n,k, ,j,p,e,g, ,j,p,g
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: POSIX
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Utilities
Requires-Dist: docopt (>=0.6)
Requires-Dist: requests (>=2.0)
Provides-Extra: dev
Requires-Dist: pytest; extra == 'dev'
Requires-Dist: wheel; extra == 'dev'

TinyPNG API
-----------

Python module and command line tool for `tinypng.com`_

Shrink PNG files. Advanced lossy compression for PNG images that
preserves full alpha transparency. Now also works with JPEG files.

Note: This project is not affiliated with `tinypng.com`_ or `Voormedia
B.V.`_

Important: You require an API key which you may obtain from
`tinypng.com/developers`_.

Besides specifying keys via command line arguments you can:

1. Set the environment variable TINYPNG\_API\_KEY
2. Create a .tinypng.keys file in your home directory
3. Create a tinypng.keys file in the current directory

Programatic api
~~~~~~~~~~~~~~~

::

    from tinypng import shrink_file

    # implicitly writes to "your_file.tiny.png"
    shrink_info = shrink_file("your_file.png", api_key='your_key_here')

    shrink_info = shrink_file(
        "your_input_file.png",
        api_key='your_key_here',
        out_filepath="your_output_file.png"
    )

    shrink_info == {
        "output": {
            "type": "image/png",
            "filepath": "/path/your_input_file.png",
            "size": 36988,
            "ratio": 0.8279,
            "url": "https://api.tinypng.com/output/abcdefg123456.jpg"
        },
        "url": "https://api.tinypng.com/output/abcdefg123456.jpg",
        "compression_count": "123",
        "input": {
            "type": "image/png",
            "size": 44679
        }
    }

.. _tinypng.com: https://tinypng.com
.. _Voormedia B.V.: http://voormedia.com/
.. _tinypng.com/developers: https://tinypng.com/developers


