openzip

Openzip is a Ruby library (written in Rust) for fast reading Zip files.


Keywords
ruby, rust, zip
License
MIT
Install
gem install openzip -v 1.0.4

Documentation

Openzip

Build Status Code Climate Test Coverage Gem

Openzip is a Ruby library (written in Rust) for fast extract Zip files.

Usage

Before you begin, you need to install Rust (with Cargo) on your system (see Requirements).

Openzip.extract("path/to/file.zip", "extract/path")
# returns true if the method successfully executed; otherwise, false

The DEBUG environment variable can be used to enable debug logs:

# DEBUG=true
Openzip.extract("wrong/path/file.zip", "extract/path")
# Error: No such file or directory (os error 2)
# => false

Requirements

Benchmarking

Installation

Add this line to your application's Gemfile:

gem "openzip"

And then execute:

$ bundle

Or install it yourself as:

$ gem install openzip

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/ilyasgaraev/openzip. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.