README

Table of Contents generated with DocToc

image-processor

image-processor

image-processor` es una libreria y una herramienta de línea de comandos (CLI) diseñada para generar versiones responsivas de tus imágenes de manera rápida y sencilla. Convierte imágenes individuales o directorios completos para optimizar tus diseños web. ¡Comienza a crear imágenes responsivas hoy mismo!

Licencia

Este código tiene licencia bajo la licencia pública general de GNU versión 3.0 o posterior (LGPLV3+). Puede encontrar una copia completa de la licencia en https://www.gnu.org/licenses/lgpl-3.0-standalone.htmlalone.html0-standalone.html

Caracteristicas ¿Qué te ofrece data-auditor?

CLI para crear versiones responsivas de tus images o convertir un directorio completo

Convierte un directorio completo en un directorio de imagenes responsivas, siguiendo nuestro estandar o utilizando la version que consideres mejor

Genera versiones responsivas de tus imagenes siguiendo nuestro estandar o escogiendo tus propios tamaños

Planning, Requirements Engineering and risk management / Planeacion, Ingenieria de Requerimientos y gestion del riesgo

Estas secciones del proyecto se llevara por medio de un sitio en notion de forma que puedan ser facilmente accesibles por el personal no tecnico.

Solicita el link de acceso al personal autorizado

Documentacion

El image-processor te permite generar distintas versiones de tus imagenes

Convenciones usadas durante la docuemntacion

Convenciones de notacion para la gramatica:

Los <> se utilizan para rodear un simbolo no terminal

El ::= se utiliza para reglas de produccion

Los simbolos no terminales se expresan como una cadena o caracteres normales

El siguiente grupo de pares de simbolos, se deben utilizar junto a las expresiones de la siguiente forma: el primero en cada pareja se escribe como sufijo despues de la expresion y el segundo rodea la expresion.

El ? o [] indican que la expresion es opcional

El * o {} indica que la expresion se repite 0 o mas veces

El + indica que la expresion se repite 1 o mas veces

Si se quiere usar uno de los caracteres anteriores se debe de anteceder \ con

Uso

Requisitos

Instalacion

Como usuario

composer install israeldavidvm/image-processor

composer global require israeldavidvm/image-processor

composer require israeldavidvm/image-processor

Como biblioteca (Solo si quieres crear un programa que use la libreria)

composer require israeldavidvm/image-processor

Archivo .env (esto es necesario cuando se quiere generar un esquema a partir de ña base de datos el comportamiento por defecto)

Establece una configuracion en el archivo .env. como la siguiente


API_KEY_TINYPNG=<APIKEY>

Uso desde la interfaz de linea de comandos

Para poder usar el programa solo necesitaras un archivo .env con la configuracion como se especifico anteriormente y ejecutar el comando

Analisis de directorios

Si es incluido en un proyecto por medio de require con el global (composer global require israeldavidvm/image-processor)

~/.config/composer/vendor/bin/image-processor make-ri-repository <pathToDir> [<sizes> [<pathToEnvWithKey>]]

Si es incluido en un proyecto por medio de require sin el global (composer require israeldavidvm/image-processor)

./vendor/bin/image-processor make-ri-repository <pathToDir> [<sizes> [<pathToEnvWithKey>]]

Description: Este comando te permite analizar un directorio y generar una serie de variaciones para cada imagen de acuerdo a medidas comunes en el diseño web responsivo rwd o las que les pases como parametro

Usage: make-ri-repository [ []]

Arguments: pathToDir Especifica la ruta al archivo directorio base sizes Cadena que especifica los distintos tamaños maximos horizontales en pixeles separados por coma, por ejemplo 360,720,1080,1440,1800,2160,2880,3600,4320 pathToEnvWithKey Especifica la ruta al archivo .env que contiene la clave de la API de TinyPNG [default: "./.env"]

Options: -h, --help Display help for the given command. When no command is given display help for the list command --silent Do not output any message -q, --quiet Only errors are displayed. All other output is suppressed -V, --version Display this application version --ansi|--no-ansi Force (or disable --no-ansi) ANSI output -n, --no-interaction Do not ask any interactive question -v|vv|vvv, --verbose Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Generar versiones de imagenes

Si es incluido en un proyecto por medio de require con el global (composer global require israeldavidvm/image-processor)

~/.config/composer/vendor/bin/image-processor generate-responsive-images <pathToImage> [<sizes> [<pathToEnvWithKey>]]

Si es incluido en un proyecto por medio de require sin el global (composer require israeldavidvm/image-processor)

./vendor/bin/image-processor generate-responsive-images <pathToImage> [<sizes> [<pathToEnvWithKey>]]

Description: Este comando te permite generar una serie de variaciones de una imagen de acuerdo a medidas comunes en el diseño web responsivo rwd o las que les pases como parametro para una imagen en particular

Usage: generate-responsive-images [ []]

Arguments: pathToImage Especifica la ruta al archivo de imagen del que se quieren generar las versiones responsivas sizes Cadena que especifica los distintos tamaños maximos horizontales en pixeles separados por coma, por ejemplo 360,720,1080,1440,1800,2160,2880,3600,4320 pathToEnvWithKey Especifica la ruta al archivo .env que contiene la clave de la API de TinyPNG [default: "./.env"]