Where is docs to the latest spin-api

65 views
Skip to first unread message

Anton Kulaga

unread,
Jan 25, 2014, 12:52:03 PM1/25/14
to topbrai...@googlegroups.com
Hi all,

I downloaded the latest Spin API library http://topbraid.org/spin/api/ 
but I did not find any documentation for the library. Could you tell me where is it (if anybody wrote it at all)? I am also curios where is official sourcecode repository of it (github and mercurial search did not find any spin-api projects)

Thank you

Holger Knublauch

unread,
Jan 26, 2014, 5:20:28 PM1/26/14
to topbrai...@googlegroups.com
Hi Anton,


On 1/26/2014 3:52, Anton Kulaga wrote:
Hi all,

I downloaded the latest Spin API library http://topbraid.org/spin/api/ 
but I did not find any documentation for the library. Could you tell me where is it (if anybody wrote it at all)?

There is no real documentation - please use the examples from the examples folder to get started. Being a maven project, you can also generate the JavaDoc if you prefer to look at that. I will file an enhancement request to publish this on our own web page.



I am also curios where is official sourcecode repository of it (github and mercurial search did not find any spin-api projects)

The source code is part of TopQuadrant's internal repository, because it evolves as part of the TopBraid product line. We had thought about branching off a second, public repository but this appeared to be too difficult to synchronize so we haven't done this yet.

Thanks
Holger

Anton Kulaga

unread,
Jan 27, 2014, 7:57:37 PM1/27/14
to topbrai...@googlegroups.com
Thank you for the response,

I think putting spin-api to the public repository is the best way to make it widely adopted and get more feedback and contributions from the community.

At the moment I am trying to apply SPIN in my app (that uses BigData as repository) to store and retrieve SPARQL quires and SPIN Templates ( I am not interested in other features right now ), is there any Sesame adapter for SPIN-API or at least a test suite ( + guidlines) that one can use for implementing it? I think lack of Sesame support together with lack of public repository is the main obstacle to wide SPIN adoption.


>We had thought about branching off a second, public repository but this appeared to be too difficult to synchronize so we haven't done this yet.

Well, you can have several branches (you can use git submodule to get them directly from github) as well as put a github hook to the build server (I did this with travis but actually it is possible to configure a variety of build servers there) so if somebody makes a pull request that breaks integration with other TopBraid code you will immediately know it  and will not merge that commit to the master branch.

P.S. By the way, http://spinrdf.org/ is down now ( =(

Holger Knublauch

unread,
Jan 27, 2014, 8:09:20 PM1/27/14
to topbrai...@googlegroups.com
On 1/28/2014 10:57, Anton Kulaga wrote:
Thank you for the response,

I think putting spin-api to the public repository is the best way to make it widely adopted and get more feedback and contributions from the community.

At the moment I am trying to apply SPIN in my app (that uses BigData as repository) to store and retrieve SPARQL quires and SPIN Templates ( I am not interested in other features right now ), is there any Sesame adapter for SPIN-API or at least a test suite ( + guidlines) that one can use for implementing it? I think lack of Sesame support together with lack of public repository is the main obstacle to wide SPIN adoption.

Native sesame support would require a completely new implementation, which is not on our roadmap but would be a nice open source project for someone else.

Other sesame support is available through Graph-level adapters. We have done this with TopBraid. The SPIN API doesn't care what the underlying query graph is, so it can be a Graph that redirects its requests to a Sesame server.


>We had thought about branching off a second, public repository but this appeared to be too difficult to synchronize so we haven't done this yet.

Well, you can have several branches (you can use git submodule to get them directly from github) as well as put a github hook to the build server (I did this with travis but actually it is possible to configure a variety of build servers there) so if somebody makes a pull request that breaks integration with other TopBraid code you will immediately know it  and will not merge that commit to the master branch.

We would not be able to let 3rd party code go directly into the product code base. I don't know git well enough to configure it in a way that would allow me to push changes to both a public and a local repository, but you are right that this is the way to go. I will discuss internally.



P.S. By the way, http://spinrdf.org/ is down now ( =(

Thanks for pointing this out - we have just moved the TQ web site and I guess the SPIN web site got temporarily deactivated. We're looking into this.

Thanks
Holger

Anton Kulaga

unread,
Jan 28, 2014, 7:36:21 AM1/28/14
to topbrai...@googlegroups.com
>We would not be able to let 3rd party code go directly into the product code base. I don't know git well enough to configure it in a way that would allow me to push changes to both a public and a local repository,

Yes, it is possible (I think even default git features will be enough for that https://help.github.com/articles/fork-a-repo. ). The common practise in git/mercurial and other distributed version control systems is that contributors from outside do no have write permissions to your git repository, so they can only make forks (copies) of it, push changes there and if they decide that those changes are worth going to your repository they make pull requests. And it is up to you to decide to reject or accept them. Usually people make hooks to github so all pull requests are build with they build server that checks if something was broken. Another thing that is sometimes done (for dual licensed repos) is warning that "by contributing you accept that the ownership of your contribution to the *****" that protects from possible argues about ownership of the code if it will be reused in commercial products.


2014-01-28 Holger Knublauch <hol...@topquadrant.com>

--
-- You received this message because you are subscribed to the Google
Group "TopBraid Suite Users", the topics of which include Enterprise Vocabulary Network (EVN), TopBraid Composer, TopBraid Live, TopBraid Insight, SPARQLMotion, SPARQL Web Pages and SPIN.
To post to this group, send email to
topbrai...@googlegroups.com
To unsubscribe from this group, send email to
topbraid-user...@googlegroups.com
For more options, visit this group at
http://groups.google.com/group/topbraid-users?hl=en
---
You received this message because you are subscribed to a topic in the Google Groups "TopBraid Suite Users" group.
To unsubscribe from this topic, visit https://groups.google.com/d/topic/topbraid-users/PGX31cjiRpw/unsubscribe.
To unsubscribe from this group and all its topics, send an email to topbraid-user...@googlegroups.com.
For more options, visit https://groups.google.com/groups/opt_out.



--
Best regards,
Anton Kulaga
Reply all
Reply to author
Forward
0 new messages