https://github.com/panodata/imagecast

Imagecast is like ImageMagick but for Pythonistas. Optionally provides its features via HTTP API.
https://github.com/panodata/imagecast

http http-proxy image image-conversion image-manipulation image-processing image-processing-library image-processing-python image-proxy image-resize image-resizer image-resizing image-resolution image-scaling image-size proxy proxy-server rest-api

Last synced: about 2 months ago
JSON representation

Imagecast is like ImageMagick but for Pythonistas. Optionally provides its features via HTTP API.

• Host: GitHub
• URL: https://github.com/panodata/imagecast
• Owner: panodata
• License: agpl-3.0
• Created: 2020-06-05T23:41:40.000Z (almost 5 years ago)
• Default Branch: main
• Last Pushed: 2024-03-25T12:31:40.000Z (about 1 year ago)
• Last Synced: 2024-03-27T18:23:30.373Z (about 1 year ago)
• Topics: http, http-proxy, image, image-conversion, image-manipulation, image-processing, image-processing-library, image-processing-python, image-proxy, image-resize, image-resizer, image-resizing, image-resolution, image-scaling, image-size, proxy, proxy-server, rest-api
• Language: Python
• Homepage:
• Size: 74.2 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 5
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGES.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
#########

Imagecast

#########

|

.. start-badges

|ci-tests| |ci-coverage| |license| |pypi-downloads|

|python-versions| |status| |pypi-version|

.. |ci-tests| image:: https://github.com/panodata/imagecast/actions/workflows/tests.yml/badge.svg

    :target: https://github.com/panodata/imagecast/actions/workflows/tests.yml

.. |ci-coverage| image:: https://codecov.io/gh/panodata/imagecast/branch/main/graph/badge.svg

    :target: https://codecov.io/gh/panodata/imagecast

    :alt: Test suite code coverage

.. |python-versions| image:: https://img.shields.io/pypi/pyversions/imagecast.svg

    :target: https://python.org

.. |pypi-version| image:: https://img.shields.io/pypi/v/imagecast.svg

    :target: https://pypi.org/project/imagecast/

.. |status| image:: https://img.shields.io/pypi/status/imagecast.svg

    :target: https://pypi.org/project/imagecast/

.. |license| image:: https://img.shields.io/pypi/l/imagecast.svg

    :target: https://pypi.org/project/imagecast/

.. |pypi-downloads| image:: https://static.pepy.tech/badge/imagecast/month

    :target: https://pepy.tech/project/imagecast

.. end-badges

*****

About

*****

Imagecast is like ImageMagick but for Pythonistas. It is based on Pillow_,

and optionally provides its features via HTTP API.

*******

Install

*******

CLI interface::

    pip install imagecast

With HTTP API service::

    pip install imagecast[service]

********

Features

********

- Colorspace conversion: monochrome, grayscale

- Cropping with negative right/bottom offsets

- Resizing while keeping aspect ratio

- Output format: Any image formats from Pillow or raw bytes

- HTML DOM capturing using Playwright

- HTTP API, effectively implementing an image

  acquisition and conversion service

********

Synopsis

********

::

    # Display on screen

    imagecast --uri="$IMGURL" --display

    # Colorspace reduction to bi-level with threshold, output as bytes

    imagecast --uri="$IMGURL" --monochrome=200 --format=bytes

    # Colorspace reduction, cropping, resizing and format conversion

    imagecast --uri="$IMGURL" --grayscale --crop=40,50,-50,-40 --width=200 --save=test.png

    # HTML DOM capturing

    imagecast --uri="$HTMLURL" --element="#logo"

Examples::

    # Image manipulation

    imagecast --uri="https://unsplash.com/photos/WvdKljW55rM/download?force=true" --monochrome=80 --crop=850,1925,-950,-900 --width=640 --display

    # HTML DOM capturing

    imagecast --uri="https://www.iana.org/help/example-domains" --element="#logo"

HTML DOM capturing

==================

Imagecast can also capture screenshots of webpages, or elements thereof. It uses

`Playwright`_ and `Firefox`_ to convert full pages or specific DOM elements

to bitmaps.

After installing Imagecast, run::

    playwright install firefox

Then, invoke Imagecast like::

    imagecast --uri="${URL}" --display

In order to select specific elements for capturing, use the ``--element`` option

to express a DOM selector to apply::

    imagecast --uri="${URL}" --element="#panel-1" --display

HTTP API

========

``imagecast`` also provides its features using an HTTP API.

Start the Imagecast service as daemon::

    imagecast service

Examples::

    # Image manipulation

    http "http://localhost:9999/?uri=https%3A%2F%2Funsplash.com%2Fphotos%2FWvdKljW55rM%2Fdownload%3Fforce%3Dtrue&monochrome=80&crop=850,1925,-950,-900&width=640"

    # HTML DOM capturing

    http "http://localhost:9999/?uri=https://www.iana.org/help/example-domains&element=%23logo"

.. note::

    You should not run the service without restricting the

    list of allowed remote hosts on the public internet.

    To do that, invoke the service like::

        imagecast service --allowed-hosts=unsplash.com,media.example.org

    By default, no host will be allowed. If you really need to enable access

    to all upstream hosts, use ``--allowed-hosts=*``. All host names must be

    listed explicitly, wildcard notations like ``*.iana.org`` are not permitted.

*********

Prior Art

*********

- https://github.com/DictGet/ecce-homo

- https://github.com/agschwender/pilbox

- https://github.com/francescortiz/image

.. _Firefox: https://www.mozilla.org/firefox/

.. _Pillow: https://pillow.readthedocs.io/

.. _Playwright: https://playwright.dev/