Metadata-Version: 2.1
Name: bfstyle
Version: 0.7
Summary: Librería de estilo plots Brain Food
Home-page: https://github.com/ignacio365/BF_plots
Author: J. Ignacio del Rio
Author-email: jorge.delrio@ug.uchile.cl
License: MIT
Download-URL: https://github.com/ignacio365/BF_plots/tarball/0.5
Keywords: brainfood,style,plot
Platform: UNKNOWN
Description-Content-Type: text/markdown

# Brain Food style library

En esta librerÃ­a se encuentran los detalles para el uso de la librerÃ­a que le da estilo Brain Food a los grÃ¡ficos desarrollados con la librerÃ­a Seaborn de python.





La librerÃ­a contiene cuatro funciones::
  - `set_bf_style`: FunciÃ³n que establece el estilo Brain Food en los grÃ¡ficos.
  - `set_bf_palette`: FunciÃ³n que establece la paleta de colores Brain Food.
  - `select_color`: FunciÃ³n que selecciona un color de la paleta de colores.
  - `generate_gradient_colors`: FunciÃ³n que utiliza un color base y genera una lista de colores degradados.

AdemÃ¡s, la librerÃ­a permite cargar la lista de colores en `colors`.


## Usage

### Initial setup



1. Primero, se debe instalar la librerÃ­a `bfstyle`

    *Aplicar paso solo si la librerÃ­a no ha sido instalada previamente.*

    ```
    pip install bfstyle
    ```



2. Para cargar las funciones mencionadas y la lista de colores *Brain Food* solo se debe utilizar el siguiente cÃ³digo:

    ```
    import bfstyle
    from bfstyle.load_bf_style import colors, set_bf_style, set_bf_palette, select_color, generate_gradient_colors
    ```
    *Se recomienda aplicar este paso al inicio del notebook. AdemÃ¡s, se deben cargar las librerÃ­as `seaborn` y `matplotlib`.*

3. Luego se deben aplicar las funciones de la siguiente manera:
    ```
    set_bf_style()
    set_bf_palette()
    ```
Una vez aplicados estos tres pasos, los grÃ¡ficos que se realicen utilizando la librerÃ­a `seaborn` y `matplotlib` utilizarÃ¡n el estilo *Brain Food*.

*Cabe seÃ±alar que los grÃ¡ficos utilizarÃ¡n las fonts por defecto de python*

### Personalizar la fonts deseada

La funciÃ³n `set_bf_style()` permite utilizar fonts que hayan sido descargadas en formato `.ttf`, solo se necesita indicar el directorio de los archivos.
A modo de ejemplo, se muestra cÃ³mo establecer la font [Roboto](https://fonts.google.com/specimen/Roboto) en los grÃ¡ficos.
Todos los archivos `.ttf` deben estar guardados en la misma carpeta.

```
font_path="User/working_directory/fonts" # Example
set_bf_style(path_fonts=font_path)
```

*Esto Ãºltimo solo requiere que la funcion `set_bf_style()` sea ejecutada utilizando el parametro `path_fonts`*.

### Personalizar paleta de colores

La funciÃ³n `set_bf_palette` permite establecer una paleta de colores personalizada. Solo requiere una lista de los 
colores de la paleta deseada con los valores en formato `RGB`. Para aplicar una nueva paleta se debe aplicar el siguiente 
cÃ³digo:

```
new_color_list =['#FFFFFF', '#000000','#F12323'] # Example
set_bf_palette(colors=new_color_list)
```





## Otras funciones

A continuaciÃ³n, se muestra el uso de otras dos funciones: `select_color` y `generate_gradient_colors`.

Como se mencionÃ³, `select_color` facilita la selecciÃ³n de un determinado color que estÃ© en una lista y guardar el `RGB` 
en formato *string* en alguna variable.

La funciÃ³n requiere de una lista de colores y la posiciÃ³n del color. 
Cabe seÃ±alar que la primera posiciÃ³n en la lista corresponde a `1`.

Por ejemplo, si se desea seleccionar el primer color de la lista `colors` de la librerÃ­a `bfstyle` que contiene
los colores *Brain Food* en formato `RGB` se aplican las siguientes lÃ­neas de cÃ³digo:

```
colors # Brain Food colors list
first_color = select_color(colors,1) # Stores the color RGB string in first_color
```

*Al ejecutar la funciÃ³n, la pantalla mostrarÃ¡ grÃ¡ficamente el color seleccionado*.

En ocasiones se puede necesitar un degrade de colores para ampliar la paleta de colores.
Para ello solo se necesita un color base y la cantidad de colores a generar.

```
base_color = '#B01515'
degrade_color_list = generate_gradient_colors(base_color, 11)
```

*Esto Ãºltimo generarÃ¡ una lista de 11 colores en base a `base_color`*.


