Metadata-Version: 2.1
Name: python-silk
Version: 0.0.1
Summary: Python silk decode/encoder bindings using pybind11
Home-page: https://github.com/DCZYewen/Python-Silk-Module
Author: DCZYewen
Author-email: contact@basicws.net
License: UNKNOWN
Platform: UNKNOWN
Description-Content-Type: text/markdown
Provides-Extra: test
License-File: LICENSE

# pysilk

## Installation

```bash
pip install python-silk
```

If you get some issues with building, check documentation of [pybind11](https://pybind11.readthedocs.io)

## Usage

```python
from pysilk import async_decode, async_encode, decode, encode
```

Only four functions: `encode`, `decode`, `async_encode`, `async_decode`

It's very easy to use. Just follow the IDE/editor typing intergration and check out the docs of these functions

**NOTE**:

The first argument `input` can be a `str`, `pathlib.Path`, `bytes`, `BytesIO` or `BinaryIO` liked object.

`str` and `pathlib.Path` are both meaning local file path

**The source data of input and returned data must be the original PCM coded data**

## Author

[DCZYewen](https://github.com/DCZYewen/Python-Silk-Module)

## License

All the licenses are in the LICENSE file. This project is also released under BSD lisence.


