# Few Utility Functions
[![License](https://img.shields.io/github/license/ddc/ddcCryptography.svg?style=plastic)](https://github.com/ddc/ddcCryptography/blob/master/LICENSE)
[![Python](https://img.shields.io/badge/Python-3.10+-blue.svg?style=plastic)](https://www.python.org)
[![PyPi](https://img.shields.io/pypi/v/ddcCryptography.svg?style=plastic)](https://pypi.python.org/pypi/ddcCryptography)
[![Build Status](https://img.shields.io/endpoint.svg?url=https%3A//actions-badge.atrox.dev/ddc/ddcCryptography/badge?ref=main&style=plastic&label=build&logo=none)](https://actions-badge.atrox.dev/ddc/ddcCryptography/goto?ref=main)
# Install
```shell
pip install ddcCryptography
```
# Cryptography
```python
from ddcCryptography import Cryptography
cp = Cryptography()
```
+ GENERATE_PRIVATE_KEY
+ Generates a private key to be used instead of default one
+ But keep in mind that this private key will be needed to decode further strings
```
@staticmethod
cp.generate_private_key() -> str
```
+ ENCODE
+ Encodes a given string
```
cp.encode(str_to_encode: str) -> str
```
+ DECODE
+ Decodes a given string
```
cp.decode(str_to_decode: str) -> str
```
# Source Code
### Build
```shell
poetry build
```
### Run Tests
```shell
poe test
```
### Get Coverage Report
```shell
poe coverage
```
# License
Released under the [MIT License](LICENSE)
## Buy me a cup of coffee
I know there are people out there that may want to donate just to show their appreciation. Thanks in advance!
[![paypal](https://www.paypalobjects.com/en_US/i/btn/btn_donate_SM.gif)](https://www.paypal.com/donate/?business=MRJ2NVUGSK4EA&no_recurring=0&item_name=ddcCryptography¤cy_code=USD)
Raw data
{
"_id": null,
"home_page": "https://github.com/ddc/ddcCryptography",
"name": "ddcCryptography",
"maintainer": "Daniel Costa",
"docs_url": null,
"requires_python": "<4.0,>=3.10",
"maintainer_email": null,
"keywords": "python3, Cryptography, ddcCryptography, encode, decode",
"author": "Daniel Costa",
"author_email": "danieldcsta@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/de/37/162d774027a713e94b8d43bfb694dc9350e8f0dbe6e3d460935e404a3175/ddccryptography-1.0.1.tar.gz",
"platform": null,
"description": "# Few Utility Functions\n\n[![License](https://img.shields.io/github/license/ddc/ddcCryptography.svg?style=plastic)](https://github.com/ddc/ddcCryptography/blob/master/LICENSE)\n[![Python](https://img.shields.io/badge/Python-3.10+-blue.svg?style=plastic)](https://www.python.org)\n[![PyPi](https://img.shields.io/pypi/v/ddcCryptography.svg?style=plastic)](https://pypi.python.org/pypi/ddcCryptography)\n[![Build Status](https://img.shields.io/endpoint.svg?url=https%3A//actions-badge.atrox.dev/ddc/ddcCryptography/badge?ref=main&style=plastic&label=build&logo=none)](https://actions-badge.atrox.dev/ddc/ddcCryptography/goto?ref=main)\n\n\n# Install\n```shell\npip install ddcCryptography\n```\n\n# Cryptography\n```python\nfrom ddcCryptography import Cryptography\ncp = Cryptography()\n```\n\n+ GENERATE_PRIVATE_KEY\n + Generates a private key to be used instead of default one\n + But keep in mind that this private key will be needed to decode further strings\n ```\n @staticmethod\n cp.generate_private_key() -> str\n ```\n\n+ ENCODE\n + Encodes a given string\n ```\n cp.encode(str_to_encode: str) -> str\n ``` \n\n+ DECODE\n + Decodes a given string\n ```\n cp.decode(str_to_decode: str) -> str\n ```\n\n\n# Source Code\n### Build\n```shell\npoetry build\n```\n\n\n### Run Tests\n```shell\npoe test\n```\n\n\n### Get Coverage Report\n```shell\npoe coverage\n```\n\n\n# License\nReleased under the [MIT License](LICENSE)\n\n\n## Buy me a cup of coffee\nI know there are people out there that may want to donate just to show their appreciation. Thanks in advance!\n\n[![paypal](https://www.paypalobjects.com/en_US/i/btn/btn_donate_SM.gif)](https://www.paypal.com/donate/?business=MRJ2NVUGSK4EA&no_recurring=0&item_name=ddcCryptography¤cy_code=USD)\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Encode and Decode Strings",
"version": "1.0.1",
"project_urls": {
"Homepage": "https://github.com/ddc/ddcCryptography",
"Repository": "https://github.com/ddc/ddcCryptography"
},
"split_keywords": [
"python3",
" cryptography",
" ddccryptography",
" encode",
" decode"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "fd1326be3db5bf5aecd5fda627d7145a0c6e45fb4dac078e273e7f6b5ae357fb",
"md5": "1c90eb7506d659e995f7fbd55fa4727d",
"sha256": "f6eed05dcf8e810ae1d49f29ba9b390cd8082081408b3e4a8533865139389670"
},
"downloads": -1,
"filename": "ddccryptography-1.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1c90eb7506d659e995f7fbd55fa4727d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.10",
"size": 4259,
"upload_time": "2024-06-05T21:32:51",
"upload_time_iso_8601": "2024-06-05T21:32:51.342639Z",
"url": "https://files.pythonhosted.org/packages/fd/13/26be3db5bf5aecd5fda627d7145a0c6e45fb4dac078e273e7f6b5ae357fb/ddccryptography-1.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "de37162d774027a713e94b8d43bfb694dc9350e8f0dbe6e3d460935e404a3175",
"md5": "14be65fd199279f06d41f8c07b88b200",
"sha256": "bd822881c59d6b8878f28697470009d1a8f340c80da78e2e3e187387086b66be"
},
"downloads": -1,
"filename": "ddccryptography-1.0.1.tar.gz",
"has_sig": false,
"md5_digest": "14be65fd199279f06d41f8c07b88b200",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.10",
"size": 3630,
"upload_time": "2024-06-05T21:32:52",
"upload_time_iso_8601": "2024-06-05T21:32:52.875519Z",
"url": "https://files.pythonhosted.org/packages/de/37/162d774027a713e94b8d43bfb694dc9350e8f0dbe6e3d460935e404a3175/ddccryptography-1.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-05 21:32:52",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ddc",
"github_project": "ddcCryptography",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "ddccryptography"
}