https://github.com/pchampin/hydra-py

Hydra implementation of Python
https://github.com/pchampin/hydra-py

Last synced: 19 days ago
JSON representation

Hydra implementation of Python

• Host: GitHub
• URL: https://github.com/pchampin/hydra-py
• Owner: pchampin
• License: mit
• Created: 2015-10-30T11:50:12.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2021-08-25T08:34:12.000Z (about 3 years ago)
• Last Synced: 2024-10-02T15:21:11.036Z (about 1 month ago)
• Language: Python
• Size: 16.6 KB
• Stars: 39
• Watchers: 7
• Forks: 12
• Open Issues: 2
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE.md

Awesome Lists containing this project

• awesome-starred - pchampin/hydra-py - Hydra implementation of Python (others)

README

        
Hydra library for Python

========================

The primary goal is to provide a lib for easily writing Hydra-enabled clients [1]_.

A secondary goal is to provide a client for Triple Patterns Fragments [2]_,

and an RDFlib [3]_ Store backed on any TPF service.

Installation

++++++++++++

To install this library, from the projet directory, type::

    pip install .

NB: developers might want to add the ``-e`` option to the command line above,

so that modifications to the source are automatically taken into account.

Quick start

+++++++++++

To create a Hydra-enabled resource, use:

.. code:: python

    from hydra import Resource, SCHEMA

    res = Resource.from_iri(the_iri_of_the_resource)

If the resource has an API documentation associated with it,

it will be available as an attribute.

The API documentation provides access to the supported class,

their supported properties and operations.

.. code:: python

    print("Api documentation:")

    for supcls in res.api_documentation.supported_classes:

        print("  %s" % supcls.identifier)

        for supop in supcls.supported_operations:

            print("    %s" % supop.identifier)

Alternatively,

you can query the resource directly for available operations.

For example, the following searches for a suitable operation for creating a new event,

and performs it.

.. code:: python

    create_event = res.find_suitable_operation(SCHEMA.AddAction, SCHEMA.Event)

    resp, body = create_event({

        "@context": "http://schema.org/",

        "@type": "http://schema.org/Event",

        "name": "Halloween",

        "description": "This is halloween, this is halloween",

        "startDate": "2015-10-31T00:00:00Z",

        "endDate": "2015-10-31T23:59:59Z",

    })

    assert resp.status == 201, "%s %s" % (resp.status, resp.reason)

    new_event = Resource.from_iri(resp['location'])

And you can go on with the new event you just created...

Triple Pattern Fragments

++++++++++++++++++++++++

The ``hydra.tpf`` module implements of Triple Pattern Fragments specification [2]_.

In particular, it provides an implementation of Store,

so that TPF services can be used transparently:

.. code:: python

    import hydra.tpf # ensures that the TPFStore plugin is registered

    from rdflib import Graph

    g = Graph('TPFStore')

    g.open('http://data.linkeddatafragments.org/dbpedia2014')

    results = g.query("SELECT DISTINCT ?cls { [ a ?cls ] } LIMIT 10")

Note however that this is experimental at the moment...

References

++++++++++

.. [1] http://www.hydra-cg.com/

.. [2] http://www.hydra-cg.com/spec/latest/triple-pattern-fragments/

.. [3] https://rdflib.readthedocs.org/