hokkaido / archimedes

Clojure library for Blueprints (part of the Tinkerpop graph stack).

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Archimedes, a Clojure Library For Tinkerpop Blueprints

Archimedes is a Clojure library for working with graphs that conform to the Tinkerpop Blueprints interface.

Disclaimer: Titanium development is currently on hiatus. There are major breaking changes that need to be made to this library and the documentation and the primary developer (zmaril) is too busy finishing college to make them. If you are interested in making the changes, please get in touch, otherwise beware!

Project Goals

  • Provide an API that makes Tinkerpop Blueprints really easy to use from Clojure
  • Be reasonably feature complete
  • Don't introduce any significant amount of performance overhead

Community

Archimedes has a mailing list Feel free to join it and ask any questions you may have. If you have any questions about Archimedes, ask Zack on twitter or pop into #clojurewerkz on irc.

Artifacts

Archimedes artifacts are released to Clojars. If you are using Maven, add the following repository definition to your pom.xml:

<repository>
  <id>clojars.org</id>
  <url>http://clojars.org/repo</url>
</repository>

The Most Recent Release

With Leiningen:

[clojurewerkz/archimedes "1.0.0-alpha5"]

With Maven:

<dependency>
  <groupId>clojurewerkz</groupId>
  <artifactId>archimedes</artifactId>
  <version>1.0.0-alpha5</version>
</dependency>

Documentation & Examples

Archimedes documentation guides are not ready yet.

Code Examples

Our test suite has many code examples.

Supported Clojure Versions

Archimedes is built from the ground up for Clojure 1.4 and up. The most recent stable release is always recommended.

Continuous Integration

TBD: add it to travis-ci.org.

Development

Archimedes uses Leiningen 2. Make sure you have it installed and then run tests against supported Clojure versions using

lein2 all test

Then create a branch and make your changes on it. Once you are done with your changes and all tests pass, submit a pull request on Github.

License

Copyright (C) 2014 Zack Maril

Licensed under the Eclipse Public License (the same as Clojure).

About

Clojure library for Blueprints (part of the Tinkerpop graph stack).