From 369a1600524736b14ccea1b94708c5cd30b894a4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Agusti=CC=81n=20Benassi?= Date: Wed, 14 Dec 2016 16:55:57 -0300 Subject: [PATCH] =?UTF-8?q?Genero=20documentaci=C3=B3n=20para=20RTD.?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/HISTORY.md | 6 ++++++ docs/README.md | 17 +++++++++++++++++ 2 files changed, 23 insertions(+) diff --git a/docs/HISTORY.md b/docs/HISTORY.md index 9bf6a0c..06010c4 100644 --- a/docs/HISTORY.md +++ b/docs/HISTORY.md @@ -1,6 +1,12 @@ History === +0.1.1 (2016-12-01) +------------------ + +* Se incorpora validación de tipo y formato de campo +* Los métodos `DataJson.is_valid_catalog()` y `DataJson.validate_catalog()` ahora aceptan un `dict` además de un `path/to/data.json` o una url a un data.json. + 0.1.0 (2016-12-01) ------------------ diff --git a/docs/README.md b/docs/README.md index ae1f873..ecb07b5 100644 --- a/docs/README.md +++ b/docs/README.md @@ -60,6 +60,8 @@ Ambos métodos mencionados de `DataJson()` son capaces de validar archivos `data - Para validar un **archivo local**, `datajson_path_or_url` deberá ser el **path absoluto** a él. - Para validar un **archivo remoto**, `datajson_path_or_url` deberá ser una **URL que comience con 'http' o 'https'**. +Alternativamente, también se pueden validar **diccionarios**, es decir, el resultado de deserializar un archivo `data.json` en una variable. + 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 @@ -136,6 +138,21 @@ print validation_report } ``` +### Diccionario (data.json deserializado) + +El siguiente fragmento de código tendrá resultados idénticos al primero: +```python +import json +datajson_path = "tests/samples/full_data.json" + +datajson = json.load(datajson_path) + +validation_result = dj.is_valid_catalog(datajson) +validation_report = dj.validate_catalog(datajson) +(...) + +``` + ## Tests Los tests se corren con `nose`. Desde la raíz del repositorio: