ds-codigos-postales-ine-es/scripts/README.md

83 lines
2.0 KiB
Markdown
Raw Normal View History

2016-11-14 21:33:22 +01:00
# Script
2016-11-26 21:44:16 +01:00
Procesa los archivos fuente del callejero INE alojado en `../archive`.
2016-11-14 21:33:22 +01:00
Si no los encuentra, los descarga.
## Modo de Uso
$ php script.php [COMMAND SUBCOMMAND]] [OPTIONS]
Si se invoca sin subcomandos o argumentos, executa:
1. download all
2019-04-28 19:22:08 +02:00
2. process all
2016-11-14 21:33:22 +01:00
3. update
4. convert-to-json
### Opciones
COMMANDS
2019-04-28 19:22:08 +02:00
download [SUBCOMMAND] Descarga los archivos fuente, pero no los procesa.
2016-11-14 21:33:22 +01:00
Se puede especificar opcionalmente un subcomando:
2019-04-28 19:22:08 +02:00
2016-11-26 21:44:16 +01:00
year YEAR MONTH Descarga únicamente el periodo YEAR MONTH (Month es 1 ó 7)
2016-11-14 21:33:22 +01:00
all Descarga todos los años
2019-04-28 19:22:08 +02:00
2016-11-14 21:33:22 +01:00
OPTIONS
2019-04-28 19:22:08 +02:00
--force, -f Fuerza la descarga de los archivos fuente, aunque existan
2016-11-14 21:33:22 +01:00
process [SUBCOMMAND] Procesa los archivos fuente, y crea los archivos CSV/JSON.
2019-04-28 19:22:08 +02:00
2016-11-14 21:33:22 +01:00
Se puede especificar opcionalmente un subcomando:
2019-04-28 19:22:08 +02:00
2016-11-14 21:33:22 +01:00
year YEAR Procesa únicamente el año YEAR
year last Procesa únicamente el último año
historical Procesa todos los años y general histórico.
all Procesa todo
convert-to-json Convierte todos los archivos .csv almacenados en /data a .json.
2019-04-28 19:22:08 +02:00
2016-11-14 21:33:22 +01:00
update Actualiza el archivo datapackage.json
2019-04-28 19:22:08 +02:00
2016-11-14 21:33:22 +01:00
## Requisitos
* PHP 5.4+
* PHP Zip extension
2016-11-14 21:33:22 +01:00
* csvkit 1.0.0
PHP-ZIP se instala mediante:
$ sudo apt install php-zip
2016-11-14 21:33:22 +01:00
### csvkit
Para poder generar los archivos en `.json`, hay que tener instalado [csvkit](https://csvkit.readthedocs.org/en/540/index.html) y `jq`. Para este script se ha usado la version 1.0.4 de `csvkit`.
2016-11-14 21:33:22 +01:00
2019-04-28 19:22:08 +02:00
2016-11-14 21:33:22 +01:00
Se instala mediante:
$ sudo pip install csvkit
$ sudo apt install jq
2016-11-14 21:33:22 +01:00
2019-04-28 19:22:08 +02:00
2016-11-14 21:33:22 +01:00
Así mismo, `pip` tiene que estar instalado. En Ubuntu esto se hace mediante:
2019-04-28 19:22:08 +02:00
$ sudo apt-get install python-pip python-dev build-essential
$ sudo pip install --upgrade pip
$ sudo pip install --upgrade virtualenv