# 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.
Raw data
{
"_id": null,
"home_page": "https://github.com/nikhil25803/pyfidelius",
"name": "pyfidelius",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": null,
"author": "Nikhil Raj",
"author_email": "nikhil25803@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/bc/2e/d50939ca99a3ee33f53d436c509454f22b473565e60e23472a968b0354fa/pyfidelius-0.0.4.tar.gz",
"platform": null,
"description": "# PyFidelius\r\n\r\nPython SDK for Fidelius CLI, a tool designed for ECDH cryptography.\r\n\r\n## How to use it?\r\n\r\nCreate an instance of the class\r\n\r\n```py\r\nfrom pyfidelius.cryptography import Cryptography\r\n\r\necdh = Cryptography()\r\n```\r\n\r\n**NOTE** : Make sure that JRE 1.8+ is installed, to run the binaries in the release.\r\n\r\nMethods available :\r\n\r\n| Method | Details |\r\n| ----------------------- | ------------------------------------------------------------------------------------------------------------------ |\r\n| `generate_key_material` | Generates an ECDH key pair, and a random nonce. |\r\n| `encrypt` | Encrypts a given string data. |\r\n| `sane_encrypt` | Same as encrypt command, with the only difference being that it accepts base64 encoded version of the input string. |\r\n| `decrypt` | Decrypt the encoded data back to original string. |\r\n| `file_operation` | ECDH Cryptography can also be applied on file for both encryption and decryption. |\r\n\r\n> A brief documentation about each method is mentioned in the docstring of the method.\r\n",
"bugtrack_url": null,
"license": null,
"summary": "Python SDK for Fidelius CLI, a tool designed for ECDH cryptography.",
"version": "0.0.4",
"project_urls": {
"Homepage": "https://github.com/nikhil25803/pyfidelius"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0787d00d4ce6af8301555388d04e3487af7f0f98c715ba7a7821fe521acc5b4e",
"md5": "650e7e5ea0096c4ac7de1022e25d187b",
"sha256": "d220e4bbd1448b9afca131bd07d6dd706c70c82f694ab0db3a75b9667ddb1619"
},
"downloads": -1,
"filename": "pyfidelius-0.0.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "650e7e5ea0096c4ac7de1022e25d187b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 5488528,
"upload_time": "2024-06-10T06:07:21",
"upload_time_iso_8601": "2024-06-10T06:07:21.730195Z",
"url": "https://files.pythonhosted.org/packages/07/87/d00d4ce6af8301555388d04e3487af7f0f98c715ba7a7821fe521acc5b4e/pyfidelius-0.0.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "bc2ed50939ca99a3ee33f53d436c509454f22b473565e60e23472a968b0354fa",
"md5": "1e42fa9a85f3f7987a9f6e25ed79d612",
"sha256": "e3f88b9d8445aae5712c4c401ffe1d65a46a7c1c295db51ba0e1dcc9b07bd38b"
},
"downloads": -1,
"filename": "pyfidelius-0.0.4.tar.gz",
"has_sig": false,
"md5_digest": "1e42fa9a85f3f7987a9f6e25ed79d612",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 5486693,
"upload_time": "2024-06-10T06:07:33",
"upload_time_iso_8601": "2024-06-10T06:07:33.536811Z",
"url": "https://files.pythonhosted.org/packages/bc/2e/d50939ca99a3ee33f53d436c509454f22b473565e60e23472a968b0354fa/pyfidelius-0.0.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-10 06:07:33",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "nikhil25803",
"github_project": "pyfidelius",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "pyfidelius"
}
JSON
