Metadata-Version: 2.1
Name: pyfidelius
Version: 0.0.4
Summary: Python SDK for Fidelius CLI, a tool designed for ECDH cryptography.
Home-page: https://github.com/nikhil25803/pyfidelius
Author: Nikhil Raj
Author-email: nikhil25803@gmail.com
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: rich
Provides-Extra: testing
Requires-Dist: pytest>=8.2.1; extra == "testing"
Requires-Dist: flake8>=3.9; extra == "testing"

# PyFidelius

Python SDK for Fidelius CLI, a tool designed for ECDH cryptography.

## How to use it?

Create an instance of the class

```py
from pyfidelius.cryptography import Cryptography

ecdh = Cryptography()
```

**NOTE** : Make sure that JRE 1.8+ is installed, to run the binaries in the release.

Methods available :

| Method                  | Details                                                                                                            |
| ----------------------- | ------------------------------------------------------------------------------------------------------------------ |
| `generate_key_material` | Generates an ECDH key pair, and a random nonce.                                                                    |
| `encrypt`               | Encrypts a given string data.                                                                                      |
| `sane_encrypt`          | Same as encrypt command, with the only difference being that it accepts base64 encoded version of the input string. |
| `decrypt`               | Decrypt the encoded data back to original string.                                                                  |
| `file_operation`        | ECDH Cryptography can also be applied on file for both encryption and decryption.                                  |

> A brief documentation about each method is mentioned in the docstring of the method.
