Metadata-Version: 2.0
Name: filepreviews
Version: 2.0.2
Summary: Python client library and CLI tool for FilePreviews.io
Home-page: https://github.com/GetBlimp/filepreviews-python
Author: José Padilla
Author-email: jpadilla@blimp.io
License: MIT
Keywords: file previews thumbnails metadata exif ocr
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: License :: OSI Approved :: MIT License
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.2
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Topic :: Utilities
Requires-Dist: requests (>=2.7.0,<3.0.0)
Requires-Dist: click (>=4.0,<5.0)

FilePreviews.io
===============

|Build Status|
|PyPI Status|

Python client library and CLI tool for the `FilePreviews.io`_ service. Generate image previews and metadata from almost any kind of file.

Installation
------------

Using pip:

::

    $ pip install filepreviews

Using easy\_install:

::

    $ easy_install filepreviews

Usage
-----

.. code:: python

    >>> from filepreviews import FilePreviews
    >>> fp = FilePreviews(api_key='API_KEY_HERE', api_secret='API_SECRET_HERE')
    >>> fp.generate('http://www.getblimp.com/images/screenshot1.png')
    <PreviewResult at 4497022216> JSON: {
      "id": "220214ec-17ec-4f37-a790-eaea64522bf2",
      "original_file": null,
      "preview": null,
      "status": "pending",
      "thumbnails": null,
      "url": "https://api.filepreviews.io/v2/previews/220214ec-17ec-4f37-a790-eaea64522bf2/",
      "user_data": null
    }

Options
~~~~~~~

Check out the `endpoint docs`_ for all available options.

.. code:: python

    >>> options = {
    ...   'sizes': ['200x200'],
    ...   'format': 'png',
    ...   'metadata': ['exif'],
    ...   'pages': '1',
    ...   'data': {
    ...     'content_id': '1234'
    ...   }
    ... }
    >>> fp.generate('http://www.getblimp.com/images/screenshot1.png', **options)

CLI
~~~

::

    $ filepreviews \
        --api_key=API_KEY_HERE \
        --api_secret=API_SECRET_HERE \
        generate http://www.getblimp.com/images/screenshot1.png
    {
      "id": "e48c645d-8c02-40ab-9f11-2b3f2316be15",
      "original_file": null,
      "preview": null,
      "status": "pending",
      "thumbnails": null,
      "url": "https://api.filepreviews.io/v2/previews/e48c645d-8c02-40ab-9f11-2b3f2316be15/",
      "user_data": null
    }

::

    $ filepreviews \
        --api_key=API_KEY_HERE \
        --api_secret=API_SECRET_HERE \
        retrieve e48c645d-8c02-40ab-9f11-2b3f2316be15
    {
      "id": "e48c645d-8c02-40ab-9f11-2b3f2316be15",
      "original_file": null,
      "preview": null,
      "status": "pending",
      "thumbnails": null,
      "url": "https://api.filepreviews.io/v2/previews/e48c645d-8c02-40ab-9f11-2b3f2316be15/",
      "user_data": null
    }

.. _FilePreviews.io: http://filepreviews.io
.. _endpoint docs: http://filepreviews.io/docs/endpoints.html
.. |Build Status| image:: https://travis-ci.org/GetBlimp/filepreviews-python.svg?branch=master
   :target: https://travis-ci.org/GetBlimp/filepreviews-python
.. |PyPI Status| image:: https://img.shields.io/pypi/v/filepreviews.svg
   :target: https://pypi.python.org/pypi/filepreviews


