Converts and optimizes images and 3D models
Go to file
Alexis Breust b05fe4a964 Using HTTPS so that Travis is happy 2018-01-17 15:42:51 +01:00
assimp@bedf506c0a Added assimp as submodule 2018-01-17 09:35:03 +01:00
scripts script to generate MANIFEST.in 2018-01-17 15:06:42 +01:00
test image resize implemented 2018-01-15 11:22:06 +01:00
yoga allow jpg in cli options 2018-01-15 11:22:21 +01:00
.gitignore Added assimp as submodule 2018-01-17 09:35:03 +01:00
.gitmodules Using HTTPS so that Travis is happy 2018-01-17 15:42:51 +01:00
.travis.yml fixes build and ci 2018-01-17 15:36:18 +01:00
MANIFEST.in script to generate MANIFEST.in 2018-01-17 15:06:42 +01:00
README.rst fixes wrong link 2018-01-15 17:23:23 +01:00
logo.png logo 2018-01-15 17:11:24 +01:00
requirements.txt initial commit 2017-12-08 10:33:10 +01:00
setup.py fixes build and ci 2018-01-17 15:36:18 +01:00
tox.ini fixes build and ci 2018-01-17 15:36:18 +01:00

README.rst

YOGA - Yummy Optimizer for Gorgeous Assets
==========================================

.. figure:: ./logo.png
   :alt:

**YOGA** is a command-line tool and a library that can:

* convert and optimize images from various format to JPEG and PNG,
* convert and optimize 3D models from various formats to `gLTF and GLB`_.
  **(NOT YET IMPLEMENTED)**

**Images** are opened using Pillow_ and optimized using Guetzli_ (for JPEGs) and
Zopflipng_ (for PNGs).

**3D Models** are converted and optimized using assimp_. If models contain or
reference images, they are processed by YOGA's image optimizer.

Convert and optimize an image from CLI::

    yoga  image  input.png  output.png
    yoga  image  --output-format=jpeg  --jpeg-quality=84  input.png  output.jpg
    yoga  image  --help

Convert and optimize a 3D model from CLI::

    # TODO (not implemented yet)
    yoga  model  --help

.. _gLTF and GLB: https://www.khronos.org/gltf/
.. _Pillow: https://github.com/python-pillow/Pillow
.. _Guetzli: https://github.com/google/guetzli
.. _Zopflipng: https://github.com/google/zopfli
.. _assimp: https://github.com/assimp/assimp