aio-libs / aiosparql Goto Github PK

An asynchronous SPARQL client library using aiohttp

License: Apache License 2.0

Python 100.00%

aiosparql's Introduction

An asynchronous SPARQL library using aiohttp

Synopsis

from aiosparql.syntax import (
    IRI, Namespace, Node, PrefixedName, RDF, RDFTerm, Triples)

# define a namespace

class Boo(Namespace):
    __iri__ = IRI("http://boo#")
    SomeClass = PrefixedName
    website = PrefixedName
    label = PrefixedName

# create a node

node = Node("<subject>", {
    RDF.type: Boo.SomeClass,
    Boo.website: IRI("http://example.org"),
    Boo.label: "some label", # "some label" will be automatically escaped
})

# missing prefixed names will show on your IDE and fail on execution

print(Boo.something) # AttributeError!

# create triples

triples = Triples([("s", "p", "o")]) # o is automatically escaped
triples.append(("s", Boo.website, IRI("http://example.org")))
triples.extend([("s", Boo.website, IRI("http://example.org"))])

print(triples) # print the triples is a format usable directly in a SPARQL
               # query. It also groups by subject automatically for you


from aiosparql.client import SPARQLClient

client = SPARQLClient("http://dbpedia.org/sparql")
result = await client.query("select * where {?s ?p ?o} limit 1")
# result is a dict of the JSON result
result = await client.update("""
    with {{graph}}
    insert data {
        {{}}
    }
    """, triples)
# the triples will be automatically indented to produce a beautiful query


from aiosparql.escape import escape_any

print(escape_any(True)) # "true"
print(escape_any("foo")) # "foo"
print(escape_any(5)) # "5"
print(escape_any(5.5)) # "5.5"^^xsd:double

Installation

User space installation
easy_install --user aiosparql
System wide installation
easy_install aiosparql

Requirements

Python >= 3.5

Testing

In order for the tests to run, you must have the following Docker containers started:

docker run -d --name travis-virtuoso -p 8890:8890 -e SPARQL_UPDATE=true tenforce/virtuoso:1.2.0-virtuoso7.2.2
docker run -d -p 3030:3030 --name travis-fuseki -e ADMIN_PASSWORD=PASSWORD -e ENABLE_DATA_WRITE=true -e ENABLE_UPDATE=true -e ENABLE_UPLOAD=true secoresearch/fuseki

Credits

This software has been produced by Dacota One.

aiosparql's People

Contributors

Stargazers

Watchers

Forkers

cecton gridl asjongers atomsforpeace pidoorrr aahmadai isabella232 seanpm2001 keuv-grvl larsmic

aiosparql's Issues

KeyError when query includes "UNION"

pretty much the title.

I'm a big fan of this package, it helped me alot in my Masterthesis but today I seemed to have trouble with it.

from aiosparql.client import SPARQLClient

async with SPARQLClient("https://dbpedia.org/sparql") as client:
       result = await client.query("select ?redirects where {{?redirects dbo:wikiPageRedirects dbr:Big_Trout_Lake} union {dbr:Big_Trout_Lake dbo:wikiPageRedirects ?redirects}}")

this query seems to break and infact every query that includes "UNION". For now I will try to work around it by quering the endpoint two times and concatinate the results afterwards but it would be cool if you could fix that issue.

Add `async with` to open and close automatically the SPARQLSession

In the previous versions we had the possibility of using async with but it's now not possible anymore (because we removed the inheritance from ClientSession). We should implement it to make the code easier to write for the developers.

Add team admin to the repo

@asvetlov I think I just managed to lose access to my own repository facepalm Can you add aiosparql-admins to this repo?

Removes ClientSession from inheritance and implement graph store HTTP protocol

The database can also be manage with HTTP operations: http://www.w3.org/TR/sparql11-http-rdf-update/

In order to implement this, we need to free the SPARQLClient from the inherited get, put, post and delete methods.

Tests not working

Hi there, should pytest-aiohttp be installed or not? It's not in the test-requirements.txt but it's in the conftest file. When I have it installed all tests fail with

ValueError: option names {'--fast'} already added

When I don't have it installed the test_syntax and test-escape work but I get errors in 9/10 of the test_client tests. Some failures are these:

AttributeError: 'TestClient' object has no attribute 'query'

RuntimeError: There is no current event loop in thread 'MainThread'.

Relevant versions:

Python 3.5.2

aiohttp==2.3.10

pytest==4.3.1

Release v0.10.0

I think we are good for a new alpha release at this point. Can you show me how you normally do that?

Thanks

Let's put `aiosparql` under the `aio-libs` org on PyPI

See the details @ https://github.com/orgs/aio-libs/discussions/26.

For this, we'll need somebody with Owner privileges to either give me access on PyPI (the username there is the same — webknjaz) or be invited to the org by me (for that I'd need the username of such an individual).

As a bonus, this will also allow us to set up secretless publishing from GHA to PyPI and get rid of the in-repo secrets.

cc @cecton

Looking for the project maintainer

@cecton, the project initial author, doesn't use Python anymore.
She is not interesting for aiosparql project support.

I never used sparql personally and overwhelmed by other Open Source projects.

The library is looking for a project maintainer.
The responsibility is not too high, maybe the biggest challenge for now is keeping the support of the newest Python and aiohttp versions.

I can help with any question, CI setup, etc. but really love to have the project owner who is responsible for communication with users and keeping updates working.

If somebody wants to be a champion -- please left a comment.

Improve test environment

We could use a fixture to run the test server automatically for the integration tests.
We could use py.test syntax which is simpler and clearer to rewrite all the tests.

(See discussion #27 (comment) )

Switch to github actions

Travis was a great tool but now it is barely nonfunctional for open source projects.
We need the migration to GitHub Workflows.

The change is obvious and trivial; a champion is needed.

Update all `secret: ` values in `.travis.yml`

Do like this:

REPO_NAME={{ YOUR_REPO_NAME }}
travis encrypt -r "aio-libs/${REPO_NAME}" --api-endpoint 'https://api.travis-ci.com/'

Ref: https://github.com/orgs/aio-libs/teams/admins/discussions/9

View the update logs.

Add automatic deploy and pyup bot

Most of projects has this feature so each team member can trigger deploy with git tag, should be easy to do
we use pyup bot to watch updates in dependencies, very useful tool to find incompatibilities.