Metadata-Version: 2.1
Name: georef-ar-py
Version: 0.0.5
Summary: Paquete para consultas y procesamiento de respuestas sobre la API de georef-ar
Author-email: "Pablo E. Andino" <pabloe.andino@gmail.com>
Project-URL: Homepage, https://github.com/pavloae/georef-ar-py
Project-URL: Bug Tracker, https://github.com/pavloae/georef-ar-py/issues
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: requests ~=2.29.0
Requires-Dist: deepdiff ~=6.3.0
Requires-Dist: pandas ==2.0.2
Requires-Dist: aiohttp ~=3.8.3
Provides-Extra: cli
Requires-Dist: click ==8.1.3 ; extra == 'cli'

# georef-ar-py
Paquete para consultas y procesamiento de respuestas sobre la API de georef-ar

## Installation

### Install from PyPi:

`pip install georef-ar-py`

Para usar la line a de comandos:

`pip install "georef-ar-py[cli]"`


## Ejemplo de uso por linea de comando:

`geoarpy --help`
```
Usage: geoarpy [OPTIONS] COMMAND [ARGS]...

Options:
  --help  Show this message and exit.

Commands:
  batch-normalize  geoarpy batch normalize Commandline
  diff             geoarpy diff Commandline
  info             geoarpy info Commandline
  normalize        geoarpy normalize Commandline


```

### Obtener un resumen de una API

```
Usage: geoarpy info [OPTIONS]

  geoarpy info Commandline

  Obtienen un resumen de los registros en la API especificada

  url es el path a la API destino que se quiere consultar.

Options:
  --url TEXT  [default: https://apis.datos.gob.ar/georef/api/]
  --debug
  --help      Show this message and exit.

```

Obtener los datos de una API propia

`geoarpy info --url "http://mi-api.ar/georef/api/"`

Obtener los datos de la API oficial (https://apis.datos.gob.ar/georef/api/)

`geoarpy info`

### Obtener las diferencias entre dos API's

```
Usage: geoarpy diff [OPTIONS] URL

  geoarpy diff Commandline

  Calcula las diferencias de registros entre dos API's. Guarda el resultado en
  archivos de formato csv y/o json.

  url es el path a la API destino que se quiere comparar.

Options:
  --origin_url TEXT               [default:
                                  https://apis.datos.gob.ar/georef/api/]
  --layer [provincias|departamentos|municipios|localidades-censales|asentamientos|localidades|calles]
                                  [default: all]
  --extension [json|csv|both]     [default: both]
  --debug
  --help                          Show this message and exit.

```

Comparar los datos de una API propia contra la API oficial

`geoarpy diff "http://mi-api.ar/georef/api/"`

Comparar los datos entre dos API's

`geoarpy diff "http://mi-api_1.ar/georef/api/" --origin-url "http://mi-api_2.ar/georef/api/"`

### Normalizar una dirección (Obtener la nomenclatura)

```
Usage: geoarpy normalize [OPTIONS] ADDRESS

  geoarpy normalize Commandline

  Dada una direccion suministra la misma normalizada (nomenclatura) o no
  devuelve nada si no se pudo normalizar

  url es el path a la API destino que se quiere consultar.

Options:
  --url TEXT               [default: https://apis.datos.gob.ar/georef/api/]
  --token TEXT
  --provincia TEXT
  --departamento TEXT
  --localidad_censal TEXT
  --localidad TEXT
  --debug
  --help                   Show this message and exit.
```

Comparar los datos de una API propia contra la API oficial

`geoarpy normalize "feliz san martín 390" --localidad_censal="junin de los andes"`

Output:

`FELIX SAN MARTIN 390, Huiliches, Neuquén`

### Normalizar un conjunto de direcciones

```
Usage: geoarpy batch-normalize [OPTIONS] INPUT OUTPUT

  geoarpy batch normalize Commandline

  Normaliza un archivo csv con direcciones.  Se suminstra un archivo (INPUT) y
  se leen las direcciones bajo el encabezado "direccion".  Optativamente, se
  pueden suministrar columnas con información extra bajo los siguientes
  encabezados:     "localidad_censal", "localidad", "departamento",
  "provincia" Escribe los resultados a un archivo csv (OUTPUT)

  url es el path a la API destino que se quiere consultar.

Options:
  --url TEXT     [default: https://apis.datos.gob.ar/georef/api/]
  --token TEXT
  --prefix TEXT  [default: norm]
  --debug
  --help         Show this message and exit.

```

Lee las direcciones de un archivo csv y escribe los datos normalizados en un nuevo archivo

`geoarpy batch-normalize ./direciones.csv ./direcciones_normalizadas.csv`
