Skip to content

Commit

Permalink
Corrijo y compacto algunas partes del README.
Browse files Browse the repository at this point in the history
  • Loading branch information
abenassi committed Nov 30, 2016
1 parent 5c24820 commit 5dc5b12
Showing 1 changed file with 19 additions and 8 deletions.
27 changes: 19 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,6 @@ Paquete en python con herramientas para manipular y validar metadatos de catálo

## Instalación

Instalar la librería debería ser tan sencillo como un `pip install`:

* **Producción:** Desde cualquier parte

```bash
Expand All @@ -29,14 +27,27 @@ $ pip install -e .

## Uso

La librería implementa el objeto `DataJson` con varios métodos para verificar la integridad de archivos de metadatos `data.json` (locales o remotos) y manipular su contenido.

### Setup
La librería implementa un objeto, `DataJson`, con varios métodos para verificar la integridad de archivos `data.json` (locales o remotos) y manipular su contenido. Si se desea, se puede especificar un directorio absoluto (`schema_dir`) y un nombre de esquema de validacion (`schema_filename`) particular, pero *casi siempre*, sus valores por default serán adecuados, así que para empezar a trabajar, alcanza con:

`DataJson` utiliza un esquema default que cumple con el perfil de metadatos recomendado en la [Guía para el uso y la publicación de metadatos (v0.1)](https://github.com/datosgobar/paquete-apertura-datos/raw/master/docs/Gu%C3%ADa%20para%20el%20uso%20y%20la%20publicaci%C3%B3n%20de%20metadatos%20(v0.1).pdf) del [Paquete de Apertura de Datos](https://github.com/datosgobar/paquete-apertura-datos).

```python
from pydatajson import DataJson

dj = DataJson()
```

Si se desea utilizar un esquema alternativo, se debe especificar un directorio donde se almacenan los esquemas (`schema_dir`) y un nombre de esquema de validación (`schema_filename`).

```python
from pydatajson import DataJson

dj = DataJson(schema_filename="path/to/validation_schema.json",
schema_dir="path/to/schemas/directory/")
```

### Posibles validaciones de catálogos

- Si se desea un **resultado sencillo (V o F)** sobre la validez de la estructura del catálogo, se utilizará **`is_valid_catalog(datajson_path_or_url)`**.
Expand All @@ -45,11 +56,11 @@ dj = DataJson()
### Ubicación del catálogo a validar

Ambos métodos mencionados de `DataJson()` son capaces de validar archivos `data.json` locales o remotos:
- 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'**.

Por conveniencia, la carpeta [`tests/samples/`](tests/samples/) contiene varios ejemplos de `data.json`s bien y mal formados con distintos tipos de errores.
- 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'**.

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 @@ -127,9 +138,9 @@ print validation_report

## Tests

Los tests de la librería se desarrollaron con `nose`. Para correrlos, desde la raíz del repositorio:
Los tests se corren con `nose`. Desde la raíz del repositorio:
```
$ pip install nose # Sólo la primera vez
$ pip install nose # Sólo la primera vez
$ nosetests
```

Expand Down

0 comments on commit 5dc5b12

Please sign in to comment.