:file_folder: clompress

Clompress is easy to use library for working with archives, compression and decompression in Clojure.

Features

Directories are readed recursively.

Supported archives

• [x] TAR "tar"
• [x] ZIP "zip"

Supported compressions

• [x] BZIP2
• [x] GZIP
• [x] DEFLATE
• [x] LZ4 (BLOCK, FRAMED)
• [x] LZMA
• [x] XZ

For available compressions:

clompress.compression/available-compressions

Installation

Lein/Boot

[org.clojars.alperenbayramoglu/clompress "0.1.0"]

Clojure CLI/deps.edn

org.clojars.alperenbayramoglu/clompress {:mvn/version "0.1.0"}

Examples

Creating archive without compression

(clompress/archive {
	:output-stream (clojure.java.io/output-stream "my-archive.tar")
	:archive-type "tar"} ; for zip set :archive-type "zip"
	"directory1/" "directory2/file1.txt" "file2.txt")

Creating archive with compression bzip2

(clompress/archive {
	:output-stream (clojure.java.io/output-stream "my-archive.tar.bz2")
	:compression "bzip2"
	:archive-type "tar"}
	"directory1/" "directory2/file1.txt" "file2.txt")

Compressing file

(clompress.compression/compress
	(clojure.java.io/input-stream "file-to-compress.txt")
	(clojure.java.io/output-stream "compressed-file.txt.gz")
	"gz")

Decompressing file

(clompress.compression/decompress
	(clojure.java.io/input-stream "compressed-file.txt.gz")
	(clojure.java.io/output-stream "decompressed-file.txt")
	"gz")

Compressing string

(with-open [input-stream (java.io.ByteArrayInputStream. 
                           (.getBytes "test-data"))]
  (with-open [output-stream (java.io.ByteArrayOutputStream.)]
    (clompress.compression/compress input-stream output-stream "bzip2")))

Decompressing string

(with-open [input-stream (java.io.ByteArrayInputStream. 
                           (.getBytes compressed-string))]
  (with-open [output-stream (java.io.ByteArrayOutputStream.)]
    (clompress.compression/decompress input-stream output-stream "bzip2")
		(.toString output-stream)))

License

Clompress is licensed under MIT license.