Modifico archivos para release 0.1.6

HISTORY.md

@@ -1,11 +1,18 @@
 History
 =======
 
+0.1.6 (2017-01-04)
+------------------
+
+* Se incorpora el método `DataJson.generate_harvestable_catalogs()`, que filtra los datasets no deseados de un conjunto de catálogos.
+* Se agrega el parámetro `harvest` a los métodos `DataJson.generate_harvestable_catalogs()`, `DataJson.generate_datasets_report()` y `DataJson.generate_harvester_config()`, para controlar el criterio de elección de los datasets a cosechar.
+* Se agrega el parámetro `export_path` a los métodos `DataJson.generate_harvestable_catalogs()`, `DataJson.generate_datasets_report()` y `DataJson.generate_harvester_config()`, para controlar la exportación de sus resultados.
+
 0.1.4 (2016-12-23)
 ------------------
 
 * Se incorpora el método `DataJson.generate_datasets_report()`, que reporta sobre los datasets y la calidad de calidad de metadatos de un conjunto de catálogos.
-* Se incorpora el método `DataJson.generate_harvestable_catalog()`, que crea archivos de configuración para el Harvester a partir de los reportes de `generate_datasets_report()`.
+* Se incorpora el método `DataJson.generate_harvester_config()`, que crea archivos de configuración para el Harvester a partir de los reportes de `generate_datasets_report()`.
 
 0.1.3 (2016-12-19)
 ------------------

docs/HISTORY.md

@@ -1,11 +1,17 @@
 History
 =======
 
+0.1.6 (2017-01-04)
+------------------
+
+* Se incorpora el método `DataJson.generate_harvestable_catalogs()`, que filtra los datasets no deseados de un conjunto de catálogos.
+* Se agrega el parámetro `harvest` a los métodos `DataJson.generate_harvestable_catalogs()`, `DataJson.generate_datasets_report()` y `DataJson.generate_harvester_config()`, para controlar el criterio de elección de los datasets a cosechar.
+
 0.1.4 (2016-12-23)
 ------------------
 
 * Se incorpora el método `DataJson.generate_datasets_report()`, que reporta sobre los datasets y la calidad de calidad de metadatos de un conjunto de catálogos.
-* Se incorpora el método `DataJson.generate_harvestable_catalog()`, que crea archivos de configuración para el Harvester a partir de los reportes de `generate_datasets_report()`.
+* Se incorpora el método `DataJson.generate_harvester_config()`, que crea archivos de configuración para el Harvester a partir de los reportes de `generate_datasets_report()`.
 
 0.1.3 (2016-12-19)
 ------------------

docs/README.md

@@ -1,5 +1,5 @@
 pydatajson
-===
+==========
 
 [![Coverage Status](https://coveralls.io/repos/github/datosgobar/pydatajson/badge.svg?branch=master)](https://coveralls.io/github/datosgobar/pydatajson?branch=master)
 [![Build Status](https://travis-ci.org/datosgobar/pydatajson.svg?branch=master)](https://travis-ci.org/datosgobar/pydatajson)
@@ -83,7 +83,7 @@ Alternativamente, también se pueden validar **diccionarios**, es decir, el resu
 
 Por conveniencia, la carpeta [`tests/samples/`](tests/samples/) contiene varios ejemplos de `data.json`s bien y mal formados con distintos tipos de errores.
 
-### Ejemplos
+### Ejemplos de validación de catálogos
 
 #### Archivo data.json local
 
@@ -186,6 +186,45 @@ validation_report = dj.validate_catalog(datajson)
 
 ```
 
+### Ejemplos de generación de reportes y configuraciones del Harvester
+
+Si ya se sabe que se desean cosechar todos los datasets [válidos] de uno o varios catálogos, se pueden utilizar directamente el método `generate_harvester_config()`, proveyendo `harvest='all'` o `harvest='valid'` respectivamente. Si se desea revisar manualmente la lista de datasets contenidos, se puede invocar primero `generate_datasets_report()`, editar el reporte generado y luego proveérselo a `generate_harvester_config()`, junto con la opción `harvest='report'`.
+
+#### Crear un archivo de configuración eligiendo manualmente los datasets a federar
+
+```python
+catalogs = ["tests/samples/full_data.json", "http://181.209.63.71/data.json"]
+report_path = "path/to/report.xlsx"
+dj.generate_datasets_report(
+    catalogs=catalogs,
+    harvest='none', # El reporte tendrá `harvest==0` para todos los datasets
+    export_path=report_path
+)
+
+# A continuación, se debe editar el archivo de Excel 'path/to/report.xlsx',
+# cambiando a '1' el campo 'harvest' en los datasets que se quieran cosechar.
+
+config_path = 'path/to/config.csv'
+dj.generate_harvester_config(
+    harvest='report',
+    report=report_path,
+    export_path=config_path
+)
+```
+El archivo `config_path` puede ser provisto a Harvester para federar los datasets elegidos al editar el reporte intermedio `report_path`.
+
+#### Crear un archivo de configuración que incluya únicamente los datasets con metadata válida
+
+Conservando las variables anteriores:
+
+```python
+dj.generate_harvester_config(
+    catalogs=catalogs,
+    harvest='valid'
+    export_path='path/to/config.csv'
+)
+```
+
 ## Tests
 
 Los tests se corren con `nose`. Desde la raíz del repositorio:

pydatajson/__init__.py

@@ -6,4 +6,4 @@
 
 __author__ = """Datos Argentina"""
 __email__ = 'datos@modernizacion.gob.ar'
-__version__ = '0.1.4'
+__version__ = '0.1.6'

setup.py

@@ -17,7 +17,7 @@
 
 setup(
     name='pydatajson',
-    version='0.1.4',
+    version='0.1.6',
     description="Paquete en python con herramientas para generar y validar metadatos de catálogos de datos en formato data.json.",
     long_description=readme + '\n\n' + history,
     author="Datos Argentina",