https://github.com/codesyntax/scodeu

https://github.com/codesyntax/scodeu

Last synced: over 1 year ago
JSON representation

• Host: GitHub
• URL: https://github.com/codesyntax/scodeu
• Owner: codesyntax
• License: gpl-3.0
• Created: 2015-10-02T12:09:40.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2015-10-02T13:28:29.000Z (over 10 years ago)
• Last Synced: 2025-03-02T19:06:36.225Z (over 1 year ago)
• Language: Python
• Size: 148 KB
• Stars: 2
• Watchers: 9
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE.txt

Awesome Lists containing this project

README

          
Search Client for Open Data 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`_.

.. _available families, metadata and allowed types: http://opendata.euskadi.eus/contenidos-generales/-/familias-y-tipos-de-contenido-de-euskadi-net/

Search engine `users manual`_ (pdf).

.. _users manual: http://opendata.euskadi.eus/contenidos/informacion/como_reutilizar_datos/es_def/adjuntos/opendataeuskadi_tech_manualbuscador.pdf

Pseudo-REST API `information`_.

.. _information: http://opendata.euskadi.eus/w79-utilizar/es/contenidos/informacion/api_buscador_euskadinet/es_java/como_utilizar.html

LICENSE

-------

This software is licensed as is under GPL v3 license.

CONTRIBUTING

------------

Please send your PR to the projects Github_ page.

.. _github: https://github.com/codesyntax/scodeu