scodeu 0.3

'Search client for OpenData Euskadi'

This library provides a Python interface for the Euskadi.eus search engine.

Installation

The preferred way of installing is using pip:

pip install scodeu

Usage

This is a minimal search operation in OpenData family for metheorological documents in basque:

>>> import scodeu
>>> client = scodeu.OpenData()
>>> data = client.codified_search(tipo='ds_meteorologicos',
                                  lang='eu')
>>> items = data.get('items')

Families

Documents in euskadi.eus are organized in families. Every family defines its allowed content types and metadata. Metadata is used to filter results inside a content type.

Every families in euskadi.eus are available using scodeu. Best place to see available families, common metadata and allowed types is in the families.py file.

References

Theese are the base documents used to create scodeu

Information about available families, metadata and allowed types.

Search engine users manual (pdf).

Pseudo-REST API information.

LICENSE

This software is licensed as is under GPL v3 license.

CONTRIBUTING

Please send your PR to the projects Github page.