xz.cr

KO | EN

gitlite — search

#python #java #python3 #arduino #golang #machine-learning #rust #html #flask #javascript #seismology #nodejs

★ 15 Open GitHub ↗

Crystal bindings to the xz (lzma) compression library

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Crystal XZ

Crystal bindings to the XZ (lzma) compression library. Requires `liblzma` version `5.2.4` and/or higher.

## Installation

1. Add the dependency to your `shard.yml`:

```yaml
   dependencies:
     xz:
       github: naqvis/xz.cr
   ```

2. Run `shards install`

## Usage

```crystal
require "xz"
```

`XZ` shard provides both `Compress::XZ::Reader` and `Compress::XZ::Writer`.

## Example: decompress an xz file
#
```crystal
require "xz"

string = File.open("file.xz") do |file|
   Compress::XZ::Reader.open(file) do |xz|
     xz.gets_to_end
   end
end
pp string
```

## Example: compress to xz compression format
#
```crystal
require "xz"

File.write("file.txt", "abcd")

## Contributing

1. Fork it (<https://github.com/naqvis/xz.cr/fork>)
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create a new Pull Request

## Contributors

- [Ali Naqvi](https://github.com/naqvis) - creator and maintainer

xz.cr

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README