Metadata-Version: 2.1
Name: cli_for_tools
Version: 0.2.0
Summary: Cli for traps team tools
Home-page: https://github.com/IslasGECI/cli_guadalupe_data
Author: Ciencia de Datos • GECI
Author-email: ciencia.datos@islas.org.mx
Requires-Python: >=3.9
Description-Content-Type: text/markdown
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Requires-Dist: typer[all]

<a href="https://www.islas.org.mx/"><img src="https://www.islas.org.mx/img/logo.svg" align="right" width="256" /></a>
# Cli Guadalupe Data


![demo](https://github.com/IslasGECI/kanban/assets/53709062/faed1c14-9a41-4125-8140-fa58c3910cd2)

## `paco_el_chato`
Paco el chato es el asistente para las tareas de gabinete en el proyecto de erradicación de gato
feral en Isla Guadalupe.

Tiene tres habilidades:
- clasificar fotos con gatos
- generar un esbozo del mapa con trampas activas y desactivas de Isla Guadalupe
- actualizar la paquetería para hacer las tareas anteriores

## Instalación 🏗️
Podemos instalar esta aplicación usando `pip`:
```shell
pip uninstall cli-for-tools
pip install cli-for-tools
```

## Modo de uso
Para utilizar `haz-mapa` o `clasifica-fotos` debemos abrir la terminal desde la carpeta de trabajo:
1. damos doble _click_ a la carpeta de trabajo
1. damos _click_ derecho al ratón y escogemos la opción **Open Terminal**
1. escribimos el comando `paco_el_chato --help` y tendremos la ayuda general
1. escribimos el comando `paco_el_chato haz-mapa --help` y tendremos la ayuda del comando `haz-mapa`
1. escribimos el comando `paco_el_chato clasifica-fotos --help` y tendremos la ayuda del comando `clasifica-fotos`

## `haz-mapa`
Hace un esbozo del mapa de Isla Guadalupe con las trampas activas e inactivas.

``` sh
paco_el_chato haz-mapa
```

### Requerimientos
En la carpeta de trabajo deben existir los archivos:
- IG_MAPSOURCE_TRAMPAS_{fecha}.txt: Archivo que obtenemos de MapSource
- IG_POSICION_TRAMPAS_{fecha}.xlsx: Archivos con los esfuerzos de la semana

Al final generará el archivo `map_of_traps.jpg`.

### Posibles fuentes de error
Si las fechas no coinciden es posible que el mapa que generamos sea incorrecto.
Si la fecha del archivo de MapSource está una semana atrás al de posición todas las trampas aparecerán desactivas.
Por ejemplo, con los archivos `IG_POSICION_TRAMPAS_19NOV2023` e `IG_MAPSOURCE_TRAMPAS_12NOV2023.txt` obtendremos un mapa con todas las trampas desactivadas. 
Esto se debe a que a partir del archivo de MapSource generamos un nuevo archivo csv con fecha de una semana después.
Este archivo reescribe el original poniendo todas las trampas desactivas.


## `clasifica-fotos`
Clasifica las fotos que vienen de las trampas cámara.

``` sh
paco_el_chato clasifica-fotos
```

### Requerimientos
En la carpeta de trabajo debe estar una carpeta (o varias carpetas) con las fotos.
El nombre de la carpeta principal debe ser sin espacios. Por ejemplo:
- `FOTOS GATOS`: es un nombre incorrecto,
- `FOTOS_GATOS`: es un nombre correcto.


Al final generará la carpeta `cat_detected` con las fotos en las que detectó gato.

## `actualiza-comandos`
Actualiza los comandos:
- `haz-mapa`
- `clasifica-fotos`

