Titanium, a Clojure Layer On Top of Aurelius Titan

Titanium is a Clojure graph library built on top of Titan and the Tinkerpop stack.

Disclaimer: Archimedes and Titanium are currently being actively reworked with breaking API changes.

See the blog post Major Breaking Public API Changes Coming in Our Projects for a summary.

Project Goals

Make good parts of Titan easier to use from Clojure
Roughly match Neocons in terms of functionality
Take full advantage of the excellent Tinkerpop stack
Be well documented
Be well tested
Add additional features and DSL bits for convenience

Community

Titanium has a mailing list. Feel free to join it and ask any questions you may have.

To subscribe for announcements of releases, important changes and so on, please follow @ClojureWerkz on Twitter.

Project Maturity

Titanium is very young and incomplete. We put it on GitHub to gather feedback. For now, please consider using a mature library such as Neocons instead.

As the project matures, we will update this section.

Artifacts

Titanium 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/titanium "1.0.0-beta2"]

With Maven:

<dependency>
  <groupId>clojurewerkz</groupId>
  <artifactId>titanium</artifactId>
  <version>1.0.0-beta2</version>
</dependency>

Getting Started

Please refer to our Getting Started guide. Don't hesitate to join our mailing list and ask questions, too!

Documentation & Examples

Titanium documentation guides are still very much incomplete but improving week after week.

Titanium's test suite can be used to get more code examples.

Supported Clojure versions

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

Continuous Integration

Titanium Is a ClojureWerkz Project

Titanium is part of the group of Clojure libraries known as ClojureWerkz, together with Monger, Welle, Langohr, Elastisch, Neocons and several others.

Development

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

lein 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

Double licensed under the Eclipse Public License (the same as Clojure) or the Apache Public License 2.0.

Titan is licensed under the Apache Public License 2.0.

clojurewerkz / titanium

readme