Metadata-Version: 2.1
Name: filepreviews
Version: 3.0.0
Summary: Python client library and CLI tool for FilePreviews.io
Home-page: https://github.com/filepreviews/filepreviews-python
Author: Jose Padilla
Author-email: jpadilla@filepreviews.io
License: MIT
Description: 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-block:: pycon
        
            >>> from filepreviews import FilePreviews
            >>> fp = FilePreviews(api_key="API_KEY_HERE", api_secret="API_SECRET_HERE")
            >>> fp.generate("https://filesamples.com/samples/image/heic/sample1.heic")
            <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-block:: pycon
        
            >>> options = {
            ...     "sizes": ["200x200"],
            ...     "format": "png",
            ...     "metadata": ["exif"],
            ...     "pages": "1",
            ...     "data": {"content_id": "1234"},
            ... }
            >>> fp.generate("https://filesamples.com/samples/image/heic/sample1.heic", **options)
        
        CLI
        ~~~
        
        ::
        
            $ filepreviews \
                --api_key=API_KEY_HERE \
                --api_secret=API_SECRET_HERE \
                generate https://filesamples.com/samples/image/heic/sample1.heic
            {
              "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
        
Keywords: file,previews,thumbnails,metadata,exif,ocr
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Utilities
Requires-Python: >=3.6
Description-Content-Type: text/x-rst
Provides-Extra: dev
Provides-Extra: tests
