Metadata-Version: 2.1
Name: mcl
Version: 0.0.3
Summary: Python wrapper for mcl library
Home-page: https://github.com/piotrszyma/mcl-python
Author: Piotr Szyma
Author-email: thompson2908@gmail.com
License: UNKNOWN
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.7
Description-Content-Type: text/markdown

# mcl-python

`mcl-python` is a Python library that creates bindings for [mcl](https://github.com/herumi/mcl) library by `herumi`. For now the only supported curve is `MCLBN384_256`.

## Installation

**This package requires [mcl](https://github.com/herumi/mcl) to be preinstalled.**

Use the package manager [pip](https://pip.pypa.io/en/stable/) to install mcl-python.

```bash
pip install mcl
```

## Usage

```python
import mcl

fr = new mcl.Fr()
fr.setByCSPRNG()
```

For more examples, please check [tests](tests/).

## Tests

Tests are written in `unittest`.

```
python3 -m unittest discover tests/
```

## Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

## License
[MIT](https://choosealicense.com/licenses/mit/)

