lz4unipy 2.0.1

Copyright (c) 2017 CrescentApricot

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

Description: # lz4unipy

## 概要

`lz4unipy` は `unity-lz4` 互換の展開/圧縮を行うコマンドラインツールと簡易なライブラリです。

## インストール

```bash
pip3 install lz4unipy
```

## 使い方

### コマンドライン

```bash
lz4unipy [-h] [--dir DIR] infile [infile ...]
```

指定したファイルより自動的に動作モードを、パスより自動的に出力ファイル名を決定します。

### ライブラリ

```python
import lz4unipy

with open("target_file.unity3d.lz4", "rb") as f:
data = f.read()
if lz4unipy.is_compressed(data):
with open("target_file.unity3d", "wb") as w:
w.write(lz4unipy.decompress(data))

with open("target_file.unity3d", "rb") as f:
data = f.read()
if not lz4unipy.is_compressed(data):
with open("target_file.unity3d.lz4", "wb") as w:
w.write(lz4unipy.compress(data))
```

## テスト

```bash
git clone git@github.com/CrescentApricot/lz4unipy.git
cd lz4unipy
python3 setup.py test
```

### 謝辞
テスト用ファイル [sample.png](/tests/sample.png) にはバンダイナムコエンターテインメント株式会社の提供するスマートフォン向けリズムゲーム、[アイドルマスターミリオンライブ！ シアターデイズ](https://millionlive.idolmaster.jp/theaterdays/)のゲーム内スクリーンショットを利用しています。この場を借りてお礼申し上げます。

Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: Development Status :: 4 - Beta
Classifier: License :: OSI Approved :: MIT License
Classifier: Topic :: System :: Archiving :: Compression
Classifier: Topic :: Software Development :: Libraries :: Python Modules