Fast serialization library for Clojure
Find a file
2012-07-07 00:29:41 +07:00
src/taoensso Initial structure commit. 2012-07-07 00:29:41 +07:00
test/test_nippy Initial structure commit. 2012-07-07 00:29:41 +07:00
.gitignore Initial structure commit. 2012-07-07 00:29:41 +07:00
.travis.yml Initial structure commit. 2012-07-07 00:29:41 +07:00
epl-v10.html Initial structure commit. 2012-07-07 00:29:41 +07:00
project.clj Initial structure commit. 2012-07-07 00:29:41 +07:00
README.md Initial structure commit. 2012-07-07 00:29:41 +07:00

Current semantic version:

[com.taoensso/nippy "0.9.0"]

Nippy, a serialization library for Clojure

Clojure's rich data types are awesome. And its reader allows you to take your data just about anywhere. But the reader can be painfully slow when you've got a lot of data to crunch (like when you're serializing to a database).

Nippy is an attempt to provide a drop-in, high-performance alternative to the reader. It's a fork of Deep-Freeze.

What's In The Box?

  • Simple, high-performance all-Clojure de/serializer.
  • Comprehesive, extensible support for all major data types.
  • Reader-fallback for difficult/future types.
  • Full test coverage for every supported type.
  • Snappy integrated de/compression for efficient storage and network transfer.

Status Build Status

Nippy is relatively mature and is used as the Carmine Redis client serializer. The API is expected to remain more or less stable. To run tests against all supported Clojure versions, use:

lein2 all test

Known issue with Java 7 on OSX

Nippy uses Snappy which currently has a minor path issue with Java 7 on OSX. Please see here for a workaround until a proper fix is available.

Getting Started

Leiningen

Depend on Nippy in your project.clj:

[com.taoensso/nippy "0.9.0"]

and require the library:

(ns my-app (:require [taoensso.nippy :as nippy]))

De/Serializing

TODO

Performance

TODO

Performance comparison chart

Detailed benchmark information is available on Google Docs.

Nippy supports the ClojureWerkz Project Goals

ClojureWerkz is a growing collection of open-source, batteries-included Clojure libraries that emphasise modern targets, great documentation, and thorough testing.

Contact & Contribution

Reach me (Peter Taoussanis) at ptaoussanis at gmail.com for questions/comments/suggestions/whatever. I'm very open to ideas if you have any!

I'm also on Twitter: @ptaoussanis.

License

Copyright © 2012 Peter Taoussanis

Distributed under the Eclipse Public License, the same as Clojure.