Metadata-Version: 2.1
Name: pydensity
Version: 0.1.1
Summary: compress and decompress
Home-page: https://github.com/synodriver/pydensity
Author: synodriver
Author-email: diguohuangjiajinweijun@gmail.com
License: BSD
Keywords: compress,decompress,density
Classifier: Development Status :: 4 - Beta
Classifier: Operating System :: OS Independent
Classifier: License :: OSI Approved :: BSD License
Classifier: Topic :: Multimedia :: Sound/Audio
Classifier: Programming Language :: C
Classifier: Programming Language :: Cython
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Requires-Python: >=3.6
Description-Content-Type: text/markdown

<h1 align="center"><i>✨ pydensity ✨ </i></h1>

<h3 align="center">The python binding for <a href="https://github.com/k0dai/density">density</a> </h3>

[![pypi](https://img.shields.io/pypi/v/pydensity.svg)](https://pypi.org/project/pydensity/)
![python](https://img.shields.io/pypi/pyversions/pydensity)
![implementation](https://img.shields.io/pypi/implementation/pydensity)
![wheel](https://img.shields.io/pypi/wheel/pydensity)
![license](https://img.shields.io/github/license/synodriver/pydensity)
![action](https://img.shields.io/github/workflow/status/synodriver/pydensity/build%20wheel)

## 安装
```bash
pip install pydensity
```


## 使用
- encode
```python
import pydensity
origin = b"121212121212121"
size = pydensity.decompress_safe_size(len(origin))
data = pydensity.compress(origin, pydensity.Algorithm.lion)
print(pydensity.decompress(data, size))
```

## 公开函数
```python
from typing import Any
import enum

class Algorithm(enum.Enum):
    chameleon: Any
    cheetah: Any
    lion: Any

def format_state(state) -> str: ...
def major_version(): ...
def minor_version(): ...
def revision_version(): ...
def get_dictionary_size(algorithm: Algorithm): ...
def compress_safe_size(input_size: int): ...
def decompress_safe_size(input_size: int): ...

class Compressor:
    c_state: Any
    context: Any
    def __init__(self, algorithm: Algorithm, custom_dictionary: bool) -> None: ...
    @property
    def state(self): ...
    def compress(self, data: bytes) -> bytes: ...
    def __del__(self) -> None: ...

class DeCompressor:
    c_state: Any
    context: Any
    def __init__(self, data: bytes, custom_dictionary: bool) -> None: ...
    @property
    def state(self): ...
    def decompress(self, data: bytes, decompress_safe_size: int) -> bytes: ...
    def __del__(self) -> None: ...

def compress(data: bytes, algorithm: Algorithm) -> bytes: ...
def compress_into(data: bytes, out: bytearray, algorithm: Algorithm) -> int: ...
def decompress(data: bytes, decompress_safe_size: int) -> bytes: ...
def decompress_into(data: bytes, out: bytearray) -> int: ...
```

### 本机编译
```
python -m pip install setuptools wheel cython cffi
git clone https://github.com/synodriver/pydensity
cd pydensity
git submodule update --init --recursive
python setup.py bdist_wheel --use-cython --use-cffi
```

### 后端选择
默认由py实现决定，在cpython上自动选择cython后端，在pypy上自动选择cffi后端，使用```DENSITY_USE_CFFI```环境变量可以强制选择cffi
