# BGColorGenerator
BGColorGenerator es una biblioteca de Python que predice el color de fondo ideal basado en un color de texto dado, utilizando un modelo de red neuronal preentrenado. Es una herramienta perfecta para diseñadores, desarrolladores web y cualquiera que necesite generar combinaciones de colores visualmente atractivas y accesibles de manera automática.
## Instalación
Puedes instalar esta biblioteca directamente desde PyPI:
```bash
pip install BGColorGenerator
```
## Uso
### Predicción del Color de Fondo
El paquete incluye una función clave `get_bg_color` que te permite predecir el color de fondo ideal dado un color de texto en formato RGBA. También puedes visualizar el contraste entre el color de texto y el color de fondo predicho. La función tiene activado por defecto
la visualización del contraste, si no la necesitas debes de seguiente ejemplo:
```python
from BGColorGenerator.utils.colorgenerator import get_bg_color
# Definir el color del texto en formato RGBA
text_color = [255, 255, 255, 1] # Blanco opaco
# Obtener el color de fondo recomendado y visualizar el contraste
bg_color = get_bg_color(text_color, turn_off_visualization=True)
print(f'Predicted background color: {bg_color}')
```
### Funciones Clave
- **`get_bg_color(rgba_array, turn_off_visualization=False)`**: Predice el color de fondo ideal basado en un color de texto dado en formato RGBA. Opcionalmente, permite desactivar la visualización del contraste entre el color de texto y el color de fondo predicho. Devuelve un array de forma `[R, G, B, A]` representando el color de fondo recomendado.
- **`plot_contrast(color1, color2)`**: Visualiza el contraste entre dos colores en formato RGBA. Útil para evaluar visualmente cómo se verá el texto sobre el fondo.
## Requisitos
Este paquete requiere las siguientes bibliotecas de Python:
- `tensorflow>=2.0.0`
- `matplotlib`
- `pandas`
Estas dependencias se instalarán automáticamente cuando uses `pip` para instalar `bg_color_generator`.
## Ejemplos
### Predicción y Visualización
Aquà hay un ejemplo completo de cómo predecir un color de fondo y visualizarlo junto al color de texto:
```python
from BGColorGenerator.utils.colorgenerator import get_bg_color
from BGColorGenerator.utils.visualization import plot_contrast
# Color del texto en RGBA (Rojo, Verde, Azul, Alpha)
text_color = [255, 255, 255, 1] # Blanco opaco
# Predicción del color de fondo y visualización del contraste
bg_color = get_bg_color(text_color)
# Mostrar los colores
print(f'Text color: {text_color}')
print(f'Predicted background color: {bg_color}')
```
### Contribuyendo
Si te gustarÃa contribuir a este proyecto, siéntete libre de hacer un fork del repositorio, crear una rama (`git checkout -b feature/nueva-feature`), hacer tus cambios y enviar un pull request. Apreciamos cualquier contribución que pueda mejorar el proyecto.
### Licencia
Este proyecto está licenciado bajo la Licencia MIT. Para más detalles, revisa el archivo [LICENSE](LICENSE).
---
**BGColorGenerator** - Facilita la elección de colores de fondo, mejorando la estética y accesibilidad de tus proyectos.
Raw data
{
"_id": null,
"home_page": "https://github.com/joaquinsc999/BGColorGenerator",
"name": "BGColorGenerator",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": null,
"author": "Joaqu\u00edn Francisco Sol\u00f3rzano Corea",
"author_email": "joaquinscorea@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/f3/46/6ac4943928c564974ff80e672f5b73b73c3a1ea6a5b1208ee2c8e6597bdd/BGColorGenerator-2.1.3.tar.gz",
"platform": null,
"description": "\r\n# BGColorGenerator\r\n\r\nBGColorGenerator es una biblioteca de Python que predice el color de fondo ideal basado en un color de texto dado, utilizando un modelo de red neuronal preentrenado. Es una herramienta perfecta para dise\u00c3\u00b1adores, desarrolladores web y cualquiera que necesite generar combinaciones de colores visualmente atractivas y accesibles de manera autom\u00c3\u00a1tica.\r\n\r\n## Instalaci\u00c3\u00b3n\r\n\r\nPuedes instalar esta biblioteca directamente desde PyPI:\r\n\r\n```bash\r\npip install BGColorGenerator\r\n```\r\n\r\n## Uso\r\n\r\n### Predicci\u00c3\u00b3n del Color de Fondo\r\n\r\nEl paquete incluye una funci\u00c3\u00b3n clave `get_bg_color` que te permite predecir el color de fondo ideal dado un color de texto en formato RGBA. Tambi\u00c3\u00a9n puedes visualizar el contraste entre el color de texto y el color de fondo predicho. La funci\u00c3\u00b3n tiene activado por defecto\r\nla visualizaci\u00c3\u00b3n del contraste, si no la necesitas debes de seguiente ejemplo:\r\n\r\n```python\r\nfrom BGColorGenerator.utils.colorgenerator import get_bg_color\r\n\r\n# Definir el color del texto en formato RGBA\r\ntext_color = [255, 255, 255, 1] # Blanco opaco\r\n\r\n# Obtener el color de fondo recomendado y visualizar el contraste\r\nbg_color = get_bg_color(text_color, turn_off_visualization=True)\r\nprint(f'Predicted background color: {bg_color}')\r\n```\r\n\r\n### Funciones Clave\r\n\r\n- **`get_bg_color(rgba_array, turn_off_visualization=False)`**: Predice el color de fondo ideal basado en un color de texto dado en formato RGBA. Opcionalmente, permite desactivar la visualizaci\u00c3\u00b3n del contraste entre el color de texto y el color de fondo predicho. Devuelve un array de forma `[R, G, B, A]` representando el color de fondo recomendado.\r\n\r\n- **`plot_contrast(color1, color2)`**: Visualiza el contraste entre dos colores en formato RGBA. \u00c3\u0161til para evaluar visualmente c\u00c3\u00b3mo se ver\u00c3\u00a1 el texto sobre el fondo.\r\n\r\n## Requisitos\r\n\r\nEste paquete requiere las siguientes bibliotecas de Python:\r\n\r\n- `tensorflow>=2.0.0`\r\n- `matplotlib`\r\n- `pandas`\r\n\r\nEstas dependencias se instalar\u00c3\u00a1n autom\u00c3\u00a1ticamente cuando uses `pip` para instalar `bg_color_generator`.\r\n\r\n## Ejemplos\r\n\r\n### Predicci\u00c3\u00b3n y Visualizaci\u00c3\u00b3n\r\n\r\nAqu\u00c3\u00ad hay un ejemplo completo de c\u00c3\u00b3mo predecir un color de fondo y visualizarlo junto al color de texto:\r\n\r\n```python\r\nfrom BGColorGenerator.utils.colorgenerator import get_bg_color\r\nfrom BGColorGenerator.utils.visualization import plot_contrast\r\n\r\n# Color del texto en RGBA (Rojo, Verde, Azul, Alpha)\r\ntext_color = [255, 255, 255, 1] # Blanco opaco\r\n\r\n# Predicci\u00c3\u00b3n del color de fondo y visualizaci\u00c3\u00b3n del contraste\r\nbg_color = get_bg_color(text_color)\r\n\r\n# Mostrar los colores\r\nprint(f'Text color: {text_color}')\r\nprint(f'Predicted background color: {bg_color}')\r\n```\r\n\r\n### Contribuyendo\r\n\r\nSi te gustar\u00c3\u00ada contribuir a este proyecto, si\u00c3\u00a9ntete libre de hacer un fork del repositorio, crear una rama (`git checkout -b feature/nueva-feature`), hacer tus cambios y enviar un pull request. Apreciamos cualquier contribuci\u00c3\u00b3n que pueda mejorar el proyecto.\r\n\r\n### Licencia\r\n\r\nEste proyecto est\u00c3\u00a1 licenciado bajo la Licencia MIT. Para m\u00c3\u00a1s detalles, revisa el archivo [LICENSE](LICENSE).\r\n\r\n---\r\n\r\n**BGColorGenerator** - Facilita la elecci\u00c3\u00b3n de colores de fondo, mejorando la est\u00c3\u00a9tica y accesibilidad de tus proyectos.\r\n",
"bugtrack_url": null,
"license": null,
"summary": "A package for predicting the background color based on text color using a trained neural network.",
"version": "2.1.3",
"project_urls": {
"Homepage": "https://github.com/joaquinsc999/BGColorGenerator"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "fe51696a2a2a8ce9cd32513c44fe3a796dd8a87d648e8941cdd8c44333204327",
"md5": "b3cf73c8cdc0721db20df2f0c3dafd72",
"sha256": "b325d88c0d6ef326c12c457307c69fb6afd0c6e6b9d68be7ff84d40693f84124"
},
"downloads": -1,
"filename": "BGColorGenerator-2.1.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b3cf73c8cdc0721db20df2f0c3dafd72",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 2350876,
"upload_time": "2024-08-16T04:58:40",
"upload_time_iso_8601": "2024-08-16T04:58:40.020097Z",
"url": "https://files.pythonhosted.org/packages/fe/51/696a2a2a8ce9cd32513c44fe3a796dd8a87d648e8941cdd8c44333204327/BGColorGenerator-2.1.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f3466ac4943928c564974ff80e672f5b73b73c3a1ea6a5b1208ee2c8e6597bdd",
"md5": "90ab8a6ecb47898dd9d302bf3e5381bd",
"sha256": "d7d9d99a7ef17a4ff8d5e5ea63aff0cefe9b98c634549d3b1e779653b737411e"
},
"downloads": -1,
"filename": "BGColorGenerator-2.1.3.tar.gz",
"has_sig": false,
"md5_digest": "90ab8a6ecb47898dd9d302bf3e5381bd",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 2349707,
"upload_time": "2024-08-16T04:58:46",
"upload_time_iso_8601": "2024-08-16T04:58:46.773548Z",
"url": "https://files.pythonhosted.org/packages/f3/46/6ac4943928c564974ff80e672f5b73b73c3a1ea6a5b1208ee2c8e6597bdd/BGColorGenerator-2.1.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-16 04:58:46",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "joaquinsc999",
"github_project": "BGColorGenerator",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "bgcolorgenerator"
}
JSON
