Skip to content

Commit

Permalink
Genero documentación para RTD.
Browse files Browse the repository at this point in the history
  • Loading branch information
abenassi committed Dec 14, 2016
1 parent e2259b7 commit 369a160
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 0 deletions.
6 changes: 6 additions & 0 deletions 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)
------------------

Expand Down
17 changes: 17 additions & 0 deletions docs/README.md
Expand Up @@ -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
Expand Down Expand Up @@ -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:
Expand Down

0 comments on commit 369a160

Please sign in to comment.